项目简介

AIRIS MCP 网关是一个功能强大的后端服务,旨在简化与Model Context Protocol (MCP) 兼容的服务器的集成和管理。它充当LLM客户端(如Claude Code、Codex CLI)与各种后端MCP服务器之间的统一入口,处理通信、会话、凭证管理和高级功能(如LLM上下文的智能剪裁)。用户通过一个桌面应用或命令行即可轻松部署和控制整个系统。

主要功能点

  • 多MCP服务器统一管理: 作为中央枢纽,聚合和协调多个MCP服务器,包括文件系统、数据库、AI服务等。
  • LLM上下文优化: 实施OpenMCP延迟加载模式,智能地剪裁工具的JSON Schema,显著减少发送给LLM的上下文令牌数量,提高效率。
  • 安全凭证管理: 对API密钥等敏感信息进行加密存储和安全注入,确保外部服务访问的安全性。
  • 故障隔离与自愈: 内置熔断器(Circuit Breaker)机制,当后端MCP服务器出现故障时,自动隔离并尝试恢复,提升系统稳定性。
  • 桌面与Web界面: 提供直观的桌面应用和Web仪表板,方便用户启用/禁用服务器、配置API密钥和监控系统状态。
  • 多种传输协议支持: 通过HTTP SSE和JSON-RPC协议与LLM客户端通信,支持流式传输。

安装步骤

  1. 克隆仓库: 在您的终端中执行以下命令克隆项目并进入目录:
    git clone https://github.com/agiletec-inc/airis-mcp-gateway.git
    cd airis-mcp-gateway
  2. 配置环境变量: 复制 '.env.example' 文件为 '.env',您可以根据需要调整监听端口或公共域名。
    cp .env.example .env
  3. 添加本地主机映射: 运行此命令将 'gateway*.localhost' 条目写入您的 '/etc/hosts' 文件,以便在本地解析网关域名(可能需要sudo权限):
    make hosts-add
  4. 一键安装和启动: 执行此命令将构建和启动所有网关服务(包括API、UI和捆绑的MCP服务器),并自动注册编辑器配置。此过程可能需要几分钟。
    make install
  5. 可选开发者模式: 如果您需要UI/API预览,可以运行:
    make install-dev
  6. 检查服务状态: 您可以使用 'make doctor' 验证Docker可用性和工具链,或使用 'make ps' 查看容器状态。

服务器配置

MCP客户端(例如Claude Code或Codex CLI)需要配置连接到 AIRIS MCP 网关 的API代理。以下是典型的配置信息示例,您需要将其合并到您的MCP客户端的配置文件中:

{
  "mcpServers": {
    "airis-mcp-gateway": {
      "name": "AIRIS MCP Gateway",
      "url": "http://api.gateway.localhost:9400/api/v1/mcp/sse"
      // 说明:
      // - "name": 这是客户端用于识别此MCP服务器的名称。
      // - "url": 这是AIRIS MCP 网关提供的SSE(Server-Sent Events)端点,
      //   LLM客户端将通过此URL与网关通信。
      // - "command" 和 "args" 参数通常不需要为网关本身配置,因为网关作为一个
      //   正在运行的服务,客户端是连接到它,而不是启动它。
      //
      // 注意事项:
      // - URL中的域名 "http://api.gateway.localhost:9400" 是通过 'make hosts-add' 
      //   设置的本地开发域名。在生产环境或不同网络中部署时,请务必将其替换为
      //   实际可访问的公共域名和端口。
      // - '/api/v1/mcp/sse' 是网关的SSE API路径,用于Streamable HTTP MCP传输。
      // - 如果您的MCP客户端支持POST JSON-RPC请求,也可以使用不带 '/sse' 的URL:
      //   "http://api.gateway.localhost:9400/api/v1/mcp"
    }
  }
}

如何获取您的具体URL: 成功运行 'make install' 后,终端会打印出运行中的端点,通常会显示以下信息:

  • Codex Streamable HTTP MCP: 'http://api.gateway.localhost:9400/api/v1/mcp'
  • Gateway SSE endpoint: 'http://api.gateway.localhost:9400/api/v1/mcp/sse' 请根据您MCP客户端的需求(例如,是需要SSE流还是标准的JSON-RPC POST),选择并配置对应的URL。

基本使用方法

  1. 启动网关: 按照上面的安装步骤运行 'make install' 或 'make up'。
  2. 访问仪表板: 在浏览器中打开 'http://ui.gateway.localhost:5173' 来访问AIRIS MCP 网关的Web仪表板。
  3. 配置MCP服务器: 在仪表板中,您可以启用/禁用内置和外部MCP服务器(如Tavily、Supabase),并配置它们的API密钥。所有API密钥都会被加密存储。
  4. 连接LLM客户端: 根据上面提供的“服务器配置”信息,将AIRIS MCP 网关的端点URL配置到您的LLM客户端(如Claude Code、Cursor、Codex CLI)中。
  5. 使用工具: LLM客户端现在可以通过AIRIS MCP 网关调用其所代理的各种工具,如进行文件操作、数据库查询、网页浏览或利用AI能力。

信息

分类

开发者工具