Near MCP Server

🚀 NEAR 协议 MCP 服务器使用指南

本指南将帮助您快速搭建并使用 NEAR 协议 MCP 服务器，该服务器提供了丰富的账户操作、合约交互等功能，助您高效开展相关业务。

🚀 快速开始

安装与配置

1. 安装依赖

运行以下命令安装项目所需的依赖：

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

2. 创建项目结构

项目结构应按以下方式组织：

your-near-mcp-server/
├── build/                 # 编译输出目录
├── src/                  # 源代码
│   └── index.ts          # 主程序文件
└── .env                   # 环境变量配置

3. 配置环境变量

在项目根目录下创建或编辑 .env 文件，并添加以下内容：

MNEMONIC=your-24-word-mnemonic-or-empty
NEAR_NETWORK_ID=testnet # 可选值：testnet、mainnet-beta

启动服务器

开发模式启动

使用以下命令在开发模式下启动服务器：

npm run dev

生产模式启动

使用以下命令在生产模式下启动服务器：

npm start

✨ 主要特性

此 MCP 服务器具备以下强大功能：

1. 账户操作：
   • 查询余额
   • 查看账户详情
   • 创建子账户
2. 合约交互：
   • 调用合约方法
   • 部署新合约
3. 资产转移：
   • 发送 NEAR 代币
   • 转账到子账户
4. 状态查询：
   • 获取区块信息
   • 查看交易记录
5. 安全功能：
   • 管理访问密钥
   • 删除账户
   • 验证签名

💻 使用示例

基础用法

以下是与 Claude Desktop 交互的使用示例：

示例 1：查询余额

What's the balance of my account?

示例 2：调用合约方法

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

示例 3：部署合约

Deploy this contract (provide base64 WASM) to my account

📚 详细文档

安全注意事项

私钥管理

• 避免将助记词存储在不安全的位置。
• 在生产环境中，建议使用硬件钱包或其他安全措施。

访问控制

• 限制对高权限操作的访问。
• 定期审计和监控系统活动。

输入验证

• 对用户提供的所有输入进行严格的格式检查和消毒处理。

网络问题

• 确保服务器具有稳定的网络连接。
• 配置适当的错误处理机制以应对网络波动。

开发与调试

调试命令

使用以下命令检查 TypeScript 错误：

npm run check-index

常见问题排查

• 服务未启动：
  • 检查控制台输出，查看是否有错误信息。
  • 确保所有依赖项已正确安装。
• 连接问题：
  • 验证 NEAR 网络 ID 是否正确配置。
  • 确保助记词有效或为空（空表示使用默认钱包）。
• 功能异常：
  • 检查日志文件，获取详细错误信息。
  • 查看 NEAR API 文档，确认调用方式正确。

高级配置

自定义网络

在 src/index.ts 中修改网络配置：

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

扩展功能

• 实现更多 NEAR API 方法。
• 添加日志记录和监控系统。
• 开发 Web 接口以便远程调用。

文档扩展

如需进一步了解 NEAR 协议，请参考：

• NEAR 官方文档
• Near CLI 工具

通过以上步骤，您可以轻松设置并运行一个功能完善的 NEAR 协议 MCP 服务器，并与 Claude Desktop 集成使用。如果在配置或使用过程中遇到任何问题，请参考项目文档或联系社区支持获取帮助。