Skip to content

Deployment: Dockerfile and Smithery config #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Deployment: Dockerfile and Smithery config #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80c1f71
Add Dockerfile
calclavia Mar 31, 2025
2aea4f7
Add Smithery configuration
calclavia Mar 31, 2025
4ff8bbf
Update README
calclavia Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
# Use a Python image with uv pre-installed
FROM ghcr.io/astral-sh/uv:python3.10-bookworm-slim AS uv

Expand Down Expand Up @@ -36,4 +37,4 @@ COPY .env.example /app/.env
# Place executables in the environment at the front of the path
ENV PATH="/app/.venv/bin:$PATH"

ENTRYPOINT ["bicscan-mcp"]
ENTRYPOINT ["bicscan-mcp"]
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# BICScan MCP Server

[![smithery badge](https://smithery.ai/badge/@ahnlabio/bicscan-mcp)](https://smithery.ai/server/@ahnlabio/bicscan-mcp)

A powerful and efficient Blockchain address risk scoring API MCP Server, leveraging the BICScan API to provide comprehensive risk assessments and asset information for blockchain addresses, domains, and decentralized applications (dApps).


Expand All @@ -24,6 +26,14 @@ You con either use Python with `uv` or `docker` depending on your preference.

Depending on your environment, you can choose to use either `uv`, `docker`, or `uvx`.

### Installing via Smithery

To install BICScan for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@ahnlabio/bicscan-mcp):

```bash
npx -y @smithery/cli install @ahnlabio/bicscan-mcp --client claude
```

### 1. Running with `uv`

#### 1-1. Requirements
Expand Down
19 changes: 19 additions & 0 deletions smithery.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml

startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
required:
- bicscanApiKey
properties:
bicscanApiKey:
type: string
description: API key for BICScan API access.
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({ command: 'bicscan-mcp', args: [], env: { BICSCAN_API_KEY: config.bicscanApiKey } })
exampleConfig:
bicscanApiKey: YOUR_BICSCAN_API_KEY_HERE