Skip to content

Deployment: Dockerfile and Smithery config #2

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
FROM node:lts-alpine

WORKDIR /app

# Copy package files
COPY package*.json ./

# Install dependencies (ignoring scripts to avoid issues during install if any)
RUN npm install --ignore-scripts

# Copy the rest of the source code
COPY . .

# Build the project
RUN npm run build

# Expose any ports if necessary (not required for stdio based servers)

# Start the server
CMD ["node", "build/index.js"]
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MCP Etherscan Server

[![smithery badge](https://smithery.ai/badge/@5ajaki/mcp-etherscan-server)](https://smithery.ai/server/@5ajaki/mcp-etherscan-server)

An MCP (Model Context Protocol) server that provides Ethereum blockchain data tools via Etherscan's API. Features include checking ETH balances, viewing transaction history, tracking ERC20 transfers, fetching contract ABIs, monitoring gas prices, and resolving ENS names.

## Features
Expand All @@ -18,6 +20,16 @@ An MCP (Model Context Protocol) server that provides Ethereum blockchain data to

## Installation

### Installing via Smithery

To install MCP Etherscan Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@5ajaki/mcp-etherscan-server):

```bash
npx -y @smithery/cli install @5ajaki/mcp-etherscan-server --client claude
```

### Manual Installation

1. Clone the repository:
```bash
git clone [your-repo-url]
Expand Down Expand Up @@ -121,4 +133,4 @@ To add new features or modify existing ones:

## License

MIT License - See LICENSE file for details
MIT License - See LICENSE file for details
23 changes: 23 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 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:
- etherscanApiKey
properties:
etherscanApiKey:
type: string
description: Etherscan API key used to authenticate with the Etherscan API.
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({
command: 'node',
args: ['build/index.js'],
env: { ETHERSCAN_API_KEY: config.etherscanApiKey }
})
exampleConfig:
etherscanApiKey: dummy_api_key_123456