项目简介

Arcade MCP 服务器框架是一个强大的Python库,旨在帮助开发者快速构建符合Model Context Protocol (MCP) 标准的后端服务。这些服务能够以结构化、可扩展的方式向大型语言模型(LLM)客户端(如Claude Desktop, Cursor, VS Code等)提供数据访问能力、外部工具调用接口以及定制化的Prompt模板。它简化了LLM应用开发中上下文管理和功能集成的复杂性。

主要功能点

  • 工具托管与执行:轻松定义和注册Python函数作为可供LLM调用的工具。支持处理参数、秘密(Secrets)和身份验证(OAuth tokens)。
  • 上下文管理:以安全的方式向工具提供运行时上下文,包括敏感信息(如API密钥)和用户认证凭据。
  • 多传输协议支持:支持通过标准I/O(stdio)或HTTP协议与LLM客户端通信,适应不同的部署和集成场景。
  • 模块化与可扩展:提供清晰的API和最佳实践,方便开发者构建和扩展自定义工具,并将其集成到MCP服务器中。
  • CLI工具辅助:提供命令行界面(CLI)工具 'arcade new' 快速生成项目骨架,以及 'arcade configure' 辅助配置客户端连接。

安装步骤

  1. 安装 Arcade CLI 工具: 确保您的系统安装了 'uv' 包管理器 (如果未安装,请先安装 'pip install uv')。然后使用 'uv' 安装 'arcade-mcp' CLI。

    uv tool install arcade-mcp
  2. 创建新的 MCP 服务器项目: 使用 'arcade new' 命令生成一个完整的服务器项目骨架。

    arcade new my_server
    cd my_server/src/my_server

    这将生成一个包含 'server.py'(主服务器文件)、'pyproject.toml'(依赖配置)和 '.env.example'(环境变量示例)的项目。

  3. 安装项目依赖: 进入项目目录后,根据 'pyproject.toml' 安装所有依赖。

    uv pip install

服务器配置

MCP客户端需要以下信息才能连接到您的MCP服务器。这是一个JSON格式的配置示例,其中包含服务器名称、启动命令及其参数。

{
  "name": "simple_server",
  "command": "python",
  "args": [
    "server.py",
    "stdio"
  ],
  "description": "一个用于向LLM提供上下文和功能的Arcade MCP服务器",
  "transports": {
    "stdio": {
      "command": "python",
      "args": [
        "server.py",
        "stdio"
      ]
    },
    "http": {
      "command": "python",
      "args": [
        "server.py",
        "http"
      ],
      "port": 8000,
      "host": "127.0.0.1"
    }
  }
}

参数注释:

  • 'name': 您的MCP服务器的名称,用于客户端识别。
  • 'command': 启动MCP服务器的可执行文件或脚本。通常是 'python'。
  • 'args': 传递给 'command' 的参数列表。
    • 对于标准I/O ('stdio') 传输,通常是 '["server.py", "stdio"]'。
    • 对于HTTP传输,通常是 '["server.py", "http"]'。
  • 'description': 服务器的简短描述。
  • 'transports': 定义不同传输协议的具体配置。
    • 'stdio': 配置通过标准I/O与客户端通信的服务器启动命令和参数。
    • 'http': 配置通过HTTP协议与客户端通信的服务器启动命令和参数、端口和主机。

基本使用方法

  1. 运行服务器: 在项目根目录下,您可以选择使用 'stdio' 或 'http' 传输方式运行服务器。

    • 使用 stdio 传输 (默认,适合桌面应用如Claude Desktop):
      uv run server.py
      # 或直接使用 python
      python server.py
    • 使用 http 传输 (适合Web应用或IDE集成如Cursor, VS Code):
      uv run server.py http
      # 或直接使用 python
      python server.py http
      当使用HTTP传输时,您可以通过访问 'http://127.0.0.1:8000/docs' 查看API文档。
  2. 配置 MCP 客户端: 一旦服务器运行,您可以使用 'arcade configure' 命令将它连接到您偏好的AI助手。

    • 配置 Claude Desktop (stdio): 在服务器运行的目录中执行:
      arcade configure claude
    • 配置 Cursor (HTTP): 如果服务器在端口8080上以HTTP模式运行:
      arcade configure cursor --transport http --port 8080
    • 配置 VS Code (stdio): 如果您的主服务器文件是 'my_server.py':
      arcade configure vscode --entrypoint my_server.py

信息

分类

开发者工具