MCP3 Monorepo

MCP3 Monorepo

此 Monorepo 包含适用于不同区块链网络的模型上下文协议实现，提供用于访问和交互区块链数据的工具和服务。

如何将 MCP3 用于 SUI

MCP3 提供了一套全面的工具，用于与 Sui 区块链交互。主包 @mcp3/sui 提供了常见操作的 CLI 和 API，而专用包则为特定协议和用例提供额外功能。

Claude Desktop 快速入门

将以下内容添加到你的 Claude Desktop 配置中

{
  ...
  "mcpServers": {
    ...
    "mcp3-sui": {
      "command": "npx",
      "args": [
        "-y",
        "@mcp3/sui",
        "start",
        "-t"
      ]
    }
    ...
  }
}

使用 CLI

要查看可用命令和选项列表，请运行：

npx @mcp3/sui --help

使用 Tool 命令

MCP3 提供了统一的 tool 命令，将所有子项目中的工具组织为子命令。要查看所有可用工具，请运行：

npx @mcp3/sui tool

这将显示按前缀分组的所有可用工具列表（例如，sui-cetus、sui-wallets 等）。

要运行特定工具，请使用：

npx @mcp3/sui tool <tool-name> [options]

例如：

npx @mcp3/sui tool sui-wallets-list
npx @mcp3/sui tool sui-cetus-pool-list

软件包

核心软件包

• @mcp3/common：所有实现共用的实用工具、类型和工具
• @mcp3/eth：以太坊的模型上下文协议实现
• @mcp3/sui：Sui Network 的模型上下文协议实现

Sui 生态系统软件包

• @mcp3/sui-base：Sui Network 的基础实用工具和工具
• @mcp3/sui-wallets：Sui Network 的钱包管理工具
• @mcp3/sui-cetus：Sui Network 的 Cetus Protocol 集成
• @mcp3/sui-navi：Sui Network 的 Navi Protocol 集成

数据集成软件包

• @mcp3/dex-screener：MCP3 的 DexScreener API 集成
• @mcp3/defilama：MCP3 的 DeFiLlama API 集成

交易管理

• @mcp3/transaction-server：用于处理交易和提供交易 UI 的服务
• @mcp3/transaction-ui：用于交易签名和提交的 React 组件库

开发

本项目使用 pnpm 作为包管理器，并使用工作区管理 Monorepo。

CLI 结构

MCP3 使用统一的 CLI 结构：

1. 子项目中的所有工具都注册为主 tool 命令的子命令
2. 未指定具体工具时，CLI 会自动列出所有可用工具
3. 工具按前缀分组，以便更好地组织
4. 工具只能通过 tool 命令访问

实现新工具时：

1. 在你的包中使用 registration.addTool() 注册工具
2. 创建一个回调函数，用于注册包中的所有工具
3. 将此回调作为第二个参数传递给 startCli 函数

示例：

// Create a callback function to register tools
const registerTools = async (reg: Registration) => {
    // Register your tools
    registerYourTools(reg);
};

// Register tools immediately for the main CLI
registerTools(registration);

// Pass the callback to startCli
startCli(registration, registerTools);

前置条件

• Node.js（v18 或更高版本）
• pnpm（v8 或更高版本）

设置

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Clean all packages
pnpm clean

# Run tests
pnpm test

使用各个软件包

# Build a specific package
pnpm --filter @mcp3/eth build

# Run a specific package
pnpm --filter @mcp3/sui start

# Run tests for a specific package
pnpm --filter @mcp3/sui-navi test

软件包依赖关系

此 Monorepo 中的软件包具有以下依赖关系：

• 大多数软件包都依赖 @mcp3/common 以使用共享实用工具
• Sui 相关软件包依赖 @mcp3/sui-base 以使用核心 Sui 功能
• @mcp3/sui 对多个 Sui 生态系统软件包具有对等依赖
• @mcp3/transaction-server 依赖 @mcp3/transaction-ui 来提供 UI

版本管理

此 Monorepo 中的软件包采用独立版本管理。进行更改时：

1. 对某个软件包的更改会触发该软件包及其依赖项的版本升级
2. 升级版本时，记得包含 sui-navi 软件包
3. 创建捆绑包时，请从捆绑包中排除 transaction-server 和 transaction-ui 项目，但将它们添加为依赖项

测试

每个软件包都有自己的测试套件。对于 sui-navi 项目，测试遵循与 sui-wallets 相同的模式，使用 node:tests 框架，并将 tsx 用作开发依赖项。

# Run all tests
pnpm test

# Run tests for a specific package
pnpm --filter @mcp3/sui-navi test

贡献

欢迎为 MCP3 做出贡献！以下是一些指南：

1. Fork 此仓库并创建功能分支
2. 按照项目的代码风格进行修改
3. 根据需要添加或更新测试
4. 更新文档以反映你的修改
5. 提交 pull request，并清楚描述所做的修改

许可证

ISC