Nebulablock Mcp Server

NebulaBlock API MCP

此仓库包含官方的 NebulaBlock API Model Context Protocol（MCP）服务。该服务集成了 fastmcp 库，将 NebulaBlock API 的全部功能作为可访问的工具提供，使其能够在任何兼容 MCP 的环境中实现无缝、高效的交互。

项目结构

.
├── src/
│   ├── __init__.py
│   ├── config.py
│   ├── main.py
│   ├── tools.py
│   └── mcp_project.egg-info/
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── scripts/
├── docs/
├── .env.example
├── .gitignore
├── pyproject.toml
├── README.md
└── uv.lock

• src/：包含主要应用程序源代码，包括配置和工具定义。
• tests/：包含单元测试和集成测试。
• scripts/：用于存放实用脚本（例如，设置和数据生成）。
• docs/：用于存放补充文档。
• .env.example：环境变量示例文件。
• .gitignore：指定要忽略的有意不跟踪的文件。
• pyproject.toml：项目元数据和构建系统配置，包括依赖项和项目信息。
• README.md：此文档文件。
• uv.lock：uv 依赖管理的锁定文件。

安装和设置

按照以下步骤设置并运行此项目：

1. 克隆仓库（如适用）：

   git clone https://github.com/Nebula-Block-Data/api-mcp
   cd mcp-project
   

2. 创建虚拟环境： 强烈建议使用虚拟环境管理项目依赖项。

   python3 -m venv .venv
   

3. 激活虚拟环境：

   • macOS/Linux：

source .venv/bin/activate

4. 安装依赖项： 此项目使用 pyproject.toml 管理依赖项。先安装 setuptools，然后以可编辑模式安装项目。

   uv pip install -e .
   

   这将安装 fastmcp 以及 pyproject.toml 中指定的其他依赖项。

运行 NebulaBlock API MCP 服务

要启动 NebulaBlock API MCP 服务：

uv run -m src.main

你应该会看到类似以下的输出：[05/29/25 17:32:58] INFO Starting MCP server 'FastMCP' with transport 'stdio'

配置 API 密钥

可通过两种方式配置 NebulaBlock API 密钥：

1. 使用 --api-key 命令行参数： 运行应用程序时，可以直接提供 API 密钥：

   python -m src.main --api-key your_nebula_block_api_key
   

   此方法会覆盖 .env 文件中设置的任何 API 密钥。

2. 使用 .env 文件： 在项目根目录创建名为 .env 的文件，并在其中添加 API 密钥：

   NEBULA_BLOCK_API_KEY=your_nebula_block_api_key
   

   如果未提供 --api-key 参数，应用程序会自动从此文件加载 API 密钥。

运行测试

要运行单元测试，请确保已激活虚拟环境并安装了 pytest（运行 pip install -e . 时会一并安装）：

pytest

你应该会看到表明测试通过的输出。

与 MCP 客户端集成

要使用 NebulaBlock API MCP 服务，需要配置 MCP 客户端（例如，安装了 MCP 扩展的 VS Code）以连接到此服务。以下是 settings.json 文件的示例配置：

{
  "mcpServers": {
    "nebula": {
      "command": "~/path/to/uv",
      "args": [
        "--directory",
        "~/path/to/nebulablock_mcp",
        "run",
        "-m",
        "src.main",
        "--api-key=YOUR_API_KEY"
      ]
    }
  }
}

• 将 ~/path/to/uv 替换为 uv 可执行文件的实际路径。
• 将 ~/path/to/nebulablock_mcp 替换为项目目录的实际路径。
• 将 YOUR_API_KEY 替换为实际的 NebulaBlock API 密钥。

许可证

此项目基于 MIT 许可证授权。详情请参阅 LICENSE 文件（如已创建）。