项目简介

Base Builder MCP 是一个基于 Model Context Protocol (MCP) 构建的服务器，它专注于为大型语言模型 (LLM) 客户端提供关于 Base 区块链的文档和指南。通过此 MCP 服务器，LLM 能够理解和利用 Base 文档中的信息，从而更好地辅助开发者在 Base 区块链上进行应用开发。

主要功能点

文档资源访问: 提供对 Base 文档的结构化访问能力。
指南检索: 允许 LLM 客户端根据用户需求，在 Base 文档中检索相关指南。
内容提取: 能够从 Base 文档中提取文本内容，并可选地通过 OpenAI GPT-4o 模型进行 JSON 结构化处理，以便 LLM 更好地理解和利用文档信息。
代码测试工具: 提供 'testAgentResponse' 工具，允许开发者测试 LLM 生成的代码片段。

安装步骤

克隆仓库:

git clone https://github.com/youssefea/base-builder-mcp
cd base-builder-mcp

(可选) 配置 OpenAI API 密钥: 如果您希望使用 OpenAI GPT-4o 模型来结构化处理文档内容，请设置 'OPENAI_API_KEY' 环境变量。
```
echo "OPENAI_API_KEY=您的_OpenAI_API_密钥" >> .env
```
注意: OpenAI API 密钥是可选的，但推荐配置，以便更有效地利用文档内容。
安装依赖并构建服务器:
```
npm install
npx tsc
```

服务器配置

要将 Base Builder MCP 服务器添加到 MCP 客户端（如 Cursor 或 Claude），您需要配置客户端的 MCP 设置。以下是配置示例，您需要根据实际情况进行调整。

Cursor 配置 (添加到 '.cursor/mcp.json' 或 '~/.cursor/mcp.json'):

{
  "mcpServers": {
    "base-builder-mcp": {
      "command": "node",
      "args": ["/PATH_WHERE_REPO_IS_CLONED/base-builder-mcp/build/index.js"],
      "env": {
        "OPENAI_API_KEY": "" // (可选) 如果您配置了 OpenAI API 密钥，请在此处设置环境变量，否则留空
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Claude Desktop 配置 (添加到 '~/Library/Application Support/Claude/claude_desktop_config.json' (macOS) 或 '%APPDATA%\Claude\claude_desktop_config.json' (Windows)):

{
  "mcpServers": {
    "base-builder-mcp": {
      "command": "node",
      "args": ["/PATH_WHERE_REPO_IS_CLONED/base-builder-mcp/build/index.js"],
      "env": {
        "OPENAI_API_KEY": "" // (可选) 如果您配置了 OpenAI API 密钥，请在此处设置环境变量，否则留空
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

配置参数说明:

'"base-builder-mcp"': MCP 服务器的名称，可以自定义。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行时。
'"args": ["/PATH_WHERE_REPO_IS_CLONED/base-builder-mcp/build/index.js"]': 启动命令的参数，指向服务器入口文件 'index.js' 的构建后路径。 请务必将 '/PATH_WHERE_REPO_IS_CLONED' 替换为您克隆仓库的实际路径。
'"env"': 环境变量配置。 '"OPENAI_API_KEY": ""' 用于设置 OpenAI API 密钥（可选）。
'"disabled": false': 设置为 'false' 启用该 MCP 服务器。
'"autoApprove": []': 自动批准的工具列表，默认为空。

基本使用方法

配置完成后，在 MCP 客户端中，您可以通过自然语言指令来触发 Base Builder MCP 服务器的功能。

示例 (在 Cursor 中):

在规则 (Rules) 中添加 MCP 使用指南，例如：

<MCP_USE_GUIDELINE>
  <INSTRUCTION>
    If the user says "I want to build on Base", make frequent use of the BuildOnBase MCP tool from Base-Docs MCP.
  </INSTRUCTION>
  <TOOLS>
    What is the BuildOnBase tool from Base Builder MCP?
    It's a tool which allows you to browse the sidebar of Base Docs and find the relevant guides to Build on Base. If you run this tool and you get an error because the guide is not found, try other guides from the sidebar.
  </TOOLS>
</MCP_USE_GUIDELINE>

当用户输入类似 "I want to build on Base" 的指令时，MCP 客户端将根据规则调用 'BuildOnBase' 工具。
'BuildOnBase' 工具会尝试从 Base 文档中检索相关指南，并将文档内容返回给 LLM 客户端。

工具使用说明:

BuildOnBase 工具:
- 描述: 用于检索 Base 文档中关于构建的指南。
- 参数: 'guideLink' (字符串类型): Base 文档的指南链接。
- 使用场景: 当用户表达出在 Base 上构建应用的需求时，可以使用此工具来查找和提供相关的文档指南。
testAgentResponse 工具:
- 描述: 用于测试 LLM 客户端生成的代码片段。
- 参数: 'code' (字符串数组类型): 需要测试的代码片段。
- 使用场景: 开发者可以使用此工具来评估 LLM 生成代码的质量和效果。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息