使用说明

项目简介

AIO-MCP Server 是一个功能强大的 Model Context Protocol (MCP) 服务器实现,旨在为大型语言模型 (LLM) 客户端提供全面的上下文服务。它集成了 GitLab, Jira, Confluence, YouTube 等多种常用工具和服务,使 LLM 能够访问外部数据、执行特定功能,并根据预定义的 Prompt 模板与用户进行更智能的交互。

主要功能点

  • 资源 (Resources) 管理: 支持托管和管理来自 Jira 等服务的资源,允许 LLM 客户端获取项目 Issue 信息等。
  • 工具 (Tools) 注册与执行: 内置了丰富的工具集,包括:
    • 信息检索工具: Gemini AI 搜索, Brave 搜索, 网页内容抓取。
    • 效率工具: Google 日历管理, Gmail 邮件管理, Google Chat 消息发送, YouTube 视频操作, Confluence 和 Jira 知识库操作, GitLab 代码仓库操作, 命令行脚本执行, 屏幕截图。
    • RAG 工具: 支持向量数据库 Qdrant,实现文档内容索引和检索,增强 LLM 的知识库访问能力。
    • 思维工具: 顺序思考工具,帮助 LLM 进行多步骤推理和问题解决。
  • Prompt 模板 (Prompts): 支持定义和使用 Prompt 模板,例如代码审查 Prompt,以定制 LLM 的交互行为。
  • 灵活的工具启用: 可以通过环境变量灵活启用或禁用工具组,方便用户根据需求定制服务器功能。
  • 多种安装方式: 支持通过 Smithery CLI 或 Go 语言安装,方便不同技术背景的用户部署和使用。

安装步骤

方法一:通过 Smithery CLI (推荐 Claude Desktop 用户)

  1. 确保已安装 Smithery CLI
  2. 运行以下命令,Smithery 将引导您完成交互式安装和配置:
    npx -y @smithery/cli install @athapong/aio-mcp --client claude

方法二:通过 Go 安装

  1. 安装 Go: 确保您的系统已安装 Go 1.23.2 或更高版本,并配置好 Go 环境变量 (GOPATH, PATH)。

  2. 安装 AIO-MCP Server: 运行以下命令安装服务器:

    go install github.com/athapong/aio-mcp@latest

    安装成功后,'aio-mcp' 可执行文件通常位于 '$GOPATH/bin' 目录下。

  3. 配置环境变量:

    • 在服务器可执行文件所在目录或用户 Home 目录下创建 '.env' 文件。
    • 根据您需要使用的工具,配置相应的 API 密钥、Token 和 Host 信息。
    • '.env' 文件示例 (请根据实际情况填写):
      ENABLE_TOOLS= # 留空启用所有工具,或用逗号分隔指定工具组,例如:gitlab,jira
      QDRANT_HOST=your_qdrant_host
      QDRANT_PORT=6334
      QDRANT_API_KEY=your_qdrant_api_key
      ATLASSIAN_HOST=your_atlassian_host
      ATLASSIAN_EMAIL=your_atlassian_email
      ATLASSIAN_TOKEN=your_atlassian_api_token
      GITLAB_HOST=your_gitlab_host
      GITLAB_TOKEN=your_gitlab_personal_access_token
      BRAVE_API_KEY=your_brave_search_api_key
      GOOGLE_AI_API_KEY=your_google_ai_api_key
      OPENAI_API_KEY=your_openai_api_key
      GOOGLE_TOKEN_FILE=/path/to/your/token.json  # 用于 Gmail, Calendar, YouTube 等 Google 服务
      GOOGLE_CREDENTIALS_FILE=/path/to/your/credentials.json # 用于 Gmail, Calendar, YouTube 等 Google 服务
      注意: 'GOOGLE_TOKEN_FILE' 和 'GOOGLE_CREDENTIALS_FILE' 需要通过运行 'scripts/google-token/main.go' 脚本生成。

服务器配置 (MCP 客户端配置)

MCP 客户端 (例如 Claude Desktop) 需要配置 MCP 服务器的启动命令才能连接。以下是 'claude_desktop_config.json' 中配置 AIO-MCP Server 的示例:

{
  "mcpServers": {
    "aio-mcp": {
      "command": "aio-mcp",
      "args": ["-env", "/path/to/.env"]
    }
  }
}

配置参数说明:

  • server name: 'aio-mcp' (服务器名称,可自定义)
  • command: 'aio-mcp' (服务器启动命令,假设 'aio-mcp' 可执行文件已添加到系统 PATH 环境变量中,否则需要使用可执行文件的完整路径)
  • args: '["-env", "/path/to/.env"]' (传递给服务器的启动参数,'-env' 参数指定 '.env' 配置文件的路径)

或者,您也可以直接在 'claude_desktop_config.json' 中通过 'env' 字段配置环境变量,例如:

{
  "mcpServers": {
    "aio-mcp": {
      "command": "aio-mcp",
      "env": {
        "ENABLE_TOOLS": "",
        "OPENAI_API_KEY": "your_openai_api_key",
        "GITLAB_TOKEN": "your_gitlab_personal_access_token",
        // ... 其他环境变量 ...
      }
    }
  }
}

基本使用方法

  1. 启动 MCP 服务器:

    • 如果通过 Smithery 安装,服务器通常会自动启动。
    • 如果通过 Go 安装,需要在终端中运行 'aio-mcp -env /path/to/.env' 命令启动服务器。
  2. 配置 MCP 客户端:

    • 打开 MCP 客户端 (例如 Claude Desktop) 的配置界面。
    • 添加或修改 MCP 服务器配置,使用上面提供的 'claude_desktop_config.json' 示例进行配置。
  3. 在 MCP 客户端中使用工具和资源:

    • 在 LLM 对话中,可以使用 '@工具名称' 或 '资源名称' 的方式调用工具和访问资源。
    • 例如,使用 'ai_web_search' 工具进行网页搜索: '@ai_web_search question="最新的AI技术发展趋势" context="了解AI行业动态"'
    • 例如,访问 Jira Issue 资源: 'Jira Issue KP-123'

请参考仓库 README.md 文件获取更详细的工具列表、参数说明和高级配置信息。

信息

分类

开发者工具