Skip to content

fix: add missing Farcaster tool docs, HTTPS link, and config gaps #97

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
giwaov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: add missing Farcaster tool docs, HTTPS link, and config gaps #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This MCP server extends any MCP client's capabilities by providing tools to do a
- Onramp funds via [Coinbase](https://www.coinbase.com/developer-platform/products/onramp)
- Manage ERC20 tokens
- List and transfer NFTs (ERC721 and ERC1155)
- Buy [OpenRouter](http://openrouter.ai/) credits with USDC
- Buy [OpenRouter](https://openrouter.ai/) credits with USDC
- Resolve Farcaster usernames to Ethereum addresses

The server interacts with Base, powered by Base Developer Tools and [AgentKit](https://github.com/coinbase/agentkit).
Expand Down Expand Up @@ -54,6 +54,8 @@ src/
│ ├── [TOOL_NAME]/ <-------------------------- ADD DIR HERE
│ │ ├── index.ts (defines and exports tools)
│ │ ├── schemas.ts (defines input schema)
│ │ ├── types.ts (type definitions, if needed)
│ │ ├── utils.ts (utility functions, if needed)
│ └── utils/ (shared tool utilities)
```

Expand All @@ -80,6 +82,8 @@ For more detailed information on contributing to Base MCP, including adding new
- Coinbase Project ID (for onramp functionality)
- Alchemy API Key (required for NFT functionality)
- Optional: OpenRouter API Key (for buying OpenRouter credits)
- Optional: Neynar API Key (for Farcaster username resolution)
- Optional: Pinata JWT (for IPFS pinning)

## Installation

Expand Down Expand Up @@ -159,6 +163,9 @@ CHAIN_ID=your_chain_id
# Neynar API Key (required for Farcaster functionality)
# You can obtain this from https://neynar.com
NEYNAR_API_KEY=your_neynar_api_key
# Pinata JWT (optional for IPFS pinning)
# You can obtain this from https://pinata.cloud
PINATA_JWT=your_pinata_jwt
```

## Testing
Expand Down Expand Up @@ -203,6 +210,7 @@ You can easily access this file via the Claude Desktop app by navigating to Clau
"ALCHEMY_API_KEY": "your_alchemy_api_key",
"PINATA_JWT": "your_pinata_jwt",
"OPENROUTER_API_KEY": "your_openrouter_api_key",
"NEYNAR_API_KEY": "your_neynar_api_key",
"CHAIN_ID": "optional_for_base_sepolia_testnet"
},
"disabled": false,
Expand Down Expand Up @@ -393,6 +401,18 @@ Example query to Claude:

> "Buy $20 worth of OpenRouter credits."

### farcaster_username

Resolves a Farcaster username to an Ethereum address using the Neynar API.

Parameters:

- `username`: The Farcaster username to resolve

Example query to Claude:

> "What is the Ethereum address for the Farcaster user @vitalik?"

## Security Considerations

- The configuration file contains sensitive information (API keys and seed phrases). Ensure it's properly secured and not shared.
Expand Down