Near MCP Server

🚀 NEAR Protocol MCP Server Usage Guide

This guide provides a comprehensive overview of setting up, configuring, and using the NEAR Protocol MCP server. It covers installation, configuration, server startup, feature overview, usage examples, security considerations, development and debugging, advanced configuration, and additional documentation resources.

🚀 Quick Start

📦 Installation

1. Install Dependencies

npm install near-api-js zod @types/node --save

2. Create Project Structure

your-near-mcp-server/
├── build/                 # Compilation output directory
├── src/                  # Source code
│   └── index.ts          # Main program file
└── .env                   # Environment variable configuration

3. Configure Environment Variables

Create or edit the .env file in the project's root directory and add the following content:

MNEMONIC=your-24-word-mnemonic-or-empty
NEAR_NETWORK_ID=testnet # Optional values: testnet, mainnet-beta

⚙️ Start the Server

Development Mode

npm run dev

Production Mode

npm start

✨ Features

This MCP server offers the following features:

1. Account Operations:
   • Query account balance.
   • View account details.
   • Create sub - accounts.
2. Contract Interaction:
   • Call contract methods.
   • Deploy new contracts.
3. Asset Transfer:
   • Send NEAR tokens.
   • Transfer assets to sub - accounts.
4. Status Query:
   • Get block information.
   • View transaction records.
5. Security Features:
   • Manage access keys.
   • Delete accounts.
   • Verify signatures.

💻 Usage Examples (with Claude Desktop)

Basic Usage

Example 1: Query Account Balance

What's the balance of my account?

Example 2: Call a Contract Method

Call the 'add_message' function on 'guest-book.testnet' with arguments {"text": "Hello from MCP!"}

Example 3: Deploy a Contract

Deploy this contract (provide base64 WASM) to my account

🔧 Technical Details

Security Considerations

Private Key Management

• Avoid storing mnemonics in insecure locations.
• In a production environment, it is recommended to use hardware wallets or other security measures.

Access Control

• Limit access to high - privilege operations.
• Regularly audit and monitor system activities.

Input Validation

• Perform strict format checks and sanitization on all user - provided inputs.

Network Issues

• Ensure the server has a stable network connection.
• Configure appropriate error - handling mechanisms to deal with network fluctuations.

Development and Debugging

Debugging Commands

npm run check-index # Check TypeScript errors

Troubleshooting Common Issues

• Server Not Starting:
  • Check the console output for error messages.
  • Ensure all dependencies are correctly installed.
• Connection Issues:
  • Verify that the NEAR network ID is correctly configured.
  • Ensure the mnemonic is valid or empty (empty means using the default wallet).
• Functionality Issues:
  • Check the log files for detailed error information.
  • Refer to the NEAR API documentation to confirm the correct calling method.

Advanced Configuration

Custom Network

Modify the network configuration in src/index.ts:

const config = {
  networkId: process.env.NEAR_NETWORK_ID || 'testnet',
  mnemonic: process.env.MNEMONIC,
}

Extending Functionality

• Implement more NEAR API methods.
• Add logging and monitoring systems.
• Develop Web interfaces for remote calls.

📚 Documentation

For further information on the NEAR protocol, please refer to:

• NEAR Official Documentation
• Near CLI Tool

By following the steps above, you can easily set up and run a fully - functional NEAR Protocol MCP server and integrate it with Claude Desktop. If you encounter any issues during configuration or use, please refer to the project documentation or contact community support for assistance.