使用说明
项目简介
Codex MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型(LLM)应用提供丰富的区块链数据上下文。它利用 Codex 平台的数据能力,通过标准化的 MCP 协议,向兼容的 LLM 客户端(如 Claude Desktop)提供链上数据查询和分析工具。
主要功能点
- 区块链数据访问: 提供对多种区块链网络数据的访问能力,包括代币、交易对、交易所、网络状态等信息。
- 工具 (Tools): 注册并提供一系列预定义的工具,允许 LLM 客户端调用这些工具来查询和分析区块链数据。例如,可以查询代币信息、交易对数据、交易所列表、网络状态等。
- 标准化 MCP 协议: 遵循 MCP 协议标准,确保与任何兼容 MCP 协议的客户端进行无缝集成。
- Codex 数据支持: 基于 Codex 平台强大的区块链数据能力,提供高质量、实时的链上数据。
安装步骤
-
克隆仓库
打开终端,执行以下命令克隆 GitHub 仓库到本地:
git clone https://github.com/codex-data/codex-mcp.git cd codex-mcp -
安装依赖
在项目根目录下,使用 'pnpm' 安装项目依赖:
pnpm install -
构建项目
执行以下命令构建项目,生成可执行的服务器代码:
pnpm build
服务器配置
Codex MCP Server 旨在与 MCP 客户端协同工作。以下是在 MCP 客户端(如 Claude Desktop)中配置 Codex MCP Server 的方法。你需要配置服务器的启动命令 (command) 及其参数 (args),以及必要的环境变量。
Claude Desktop 配置示例 (Developer Tab -> Edit Config):
以下配置示例展示了如何在 Claude Desktop 中配置 Codex MCP Server,无需本地安装即可直接运行:
{ "mcpServers": { "codex-data": { "command": "npx", "args": ["-y", "@codex-data/codex-mcp"], "env": { "CODEX_API_KEY": "<your-codex-api-key>" } } } }
参数说明:
- '"codex-data"': 服务器名称,可以自定义。
- '"command": "npx"': 指定启动服务器的命令为 'npx',用于运行 npm 包。
- '"args": ["-y", "@codex-data/codex-mcp"]': 'npx' 命令的参数,'-y' 表示自动确认安装包,'@codex-data/codex-mcp' 是要执行的 npm 包名,即 Codex MCP Server。
- '"env": { "CODEX_API_KEY": "<your-codex-api-key>" }': 设置环境变量,'CODEX_API_KEY' 是 Codex API 密钥,请替换 '<your-codex-api-key>' 为你实际的 Codex API 密钥。你可以在 Codex Dashboard 获取 API 密钥。
本地安装后的配置 (如果选择本地安装并构建运行):
如果你选择本地安装并构建后运行服务器,可以使用以下配置,请替换 '/path/to/codex-mcp' 为你本地仓库的实际路径:
{ "mcpServers": { "codex-data": { "command": "node", "args": ["/path/to/codex-mcp/build/index.js"], "env": { "CODEX_API_KEY": "<your-codex-api-key>" } } } }
参数说明:
- '"command": "node"': 指定使用 Node.js 运行服务器。
- '"args": ["/path/to/codex-mcp/build/index.js"]': 'node' 命令的参数,指向本地 Codex MCP Server 构建后的入口文件 'build/index.js',请务必替换 '/path/to/codex-mcp' 为你本地仓库的实际路径。
基本使用方法
- 启动 MCP 客户端: 打开并配置好 Codex MCP Server 的 MCP 客户端 (例如 Claude Desktop 或 Claude CLI)。
- 连接服务器: 客户端根据配置信息连接到 Codex MCP Server。
- 使用 LLM 与区块链数据交互: 在 LLM 客户端中,你可以指示 LLM 使用 Codex MCP Server 提供的工具来查询和分析区块链数据。例如,你可以提问 "获取以太坊网络上最新发行的代币有哪些?" 或 "查询某个交易对的流动性信息"。LLM 客户端会调用 Codex MCP Server 提供的工具来执行数据查询,并将结果返回给你。
Claude CLI 使用示例:
# 添加 MCP 服务器 (需要替换 <your-codex-api-key> 为你的实际密钥) claude mcp add codex-data -e CODEX_API_KEY=<your-codex-api-key> npx @codex-data/codex-mcp # 启动 Claude CLI 并启用 MCP 服务器 claude
注意:
- 确保你已获取有效的 Codex API 密钥,并将其配置到 MCP 客户端的环境变量中。
- Codex MCP Server 提供了丰富的区块链数据查询工具,具体工具列表和使用方法可以参考项目文档或通过 MCP 客户端的功能发现机制进行探索。
信息
分类
网页与API