使用说明

项目简介

Unleash MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当 LLM 应用和 Unleash feature flag 系统的桥梁。通过此服务器，LLM 应用可以方便地获取和操作 Unleash 系统的 feature flag 数据，从而实现基于 feature flag 的上下文感知能力。

主要功能点

Feature Flag 状态查询: 允许 LLM 应用查询 Unleash 中 feature flag 的状态。
Feature Flag 信息暴露: 将 Unleash feature flag 的信息以结构化的方式提供给 LLM。
Feature Flag 管理: 支持 LLM 应用创建、更新和管理 Unleash 中的 feature flag。
项目信息获取: 允许 LLM 应用获取 Unleash 项目列表。

安装步骤

安装 Node.js 和 npm: 确保你的环境中安装了 Node.js (v18 或更高版本) 和 npm。

克隆仓库: 将 unleash-mcp 仓库克隆到本地。

git clone https://github.com/cuongtl1992/unleash-mcp.git
cd unleash-mcp

安装依赖: 在仓库目录下运行 npm 命令安装项目依赖。
```
npm install
```

服务器配置

MCP 服务器需要配置才能被 MCP 客户端（如 Claude、Cursor 等 LLM 应用）调用。以下 JSON 配置示例展示了如何配置 unleash-mcp 服务器，以便 MCP 客户端能够启动并与之通信。

{
  "mcpServers": {
    "unleash": {
      "command": "npx",  // 启动服务器的命令，这里使用 npx 来运行本地安装的 unleash-mcp
      "args": [         // 传递给命令的参数
        "unleash-mcp"   // 实际执行的脚本或命令名，对应 package.json 中的 "bin" 字段配置
      ],
      "env": {          // 环境变量配置
        "UNLEASH_URL": "YOUR_UNLEASH_END_POINT",      // **[必填]** 你的 Unleash 服务器 API 地址，例如： "http://localhost:4242"
        "UNLEASH_API_TOKEN": "YOUR_UNLEASH_API_TOKEN", // **[必填]** 你的 Unleash API token，用于服务器鉴权
        "MCP_TRANSPORT": "stdio",                     // **[可选]** MCP 通信协议，默认为 stdio，也可以设置为 "http" 使用 HTTP SSE 协议
        "MCP_HTTP_PORT": 3001                         // **[可选]** 当 MCP_TRANSPORT 为 "http" 时，服务器监听的端口，默认为 3001
      }
    }
  }
}

配置说明:

'command': 指定启动 MCP 服务器的命令，通常为 'npx' 或 'node'。
'args': 命令的参数，用于指定要执行的脚本或命令。
'env': 环境变量配置，用于设置 Unleash 服务器的连接信息和 MCP 服务器的运行参数。
- 'UNLEASH_URL': 必须配置，指向你的 Unleash 服务器 API 终端地址。
- 'UNLEASH_API_TOKEN': 必须配置，用于 Unleash API 的身份验证。
- 'MCP_TRANSPORT': 可选配置，指定 MCP 服务器使用的传输协议，默认为 'stdio' (标准输入输出)，可以设置为 'http' 使用 HTTP SSE 协议。
- 'MCP_HTTP_PORT': 可选配置，当 'MCP_TRANSPORT' 设置为 'http' 时，指定 HTTP 服务器监听的端口号，默认端口为 '3001'。

请根据你的 Unleash 服务器地址和 API Token 替换 'YOUR_UNLEASH_END_POINT' 和 'YOUR_UNLEASH_API_TOKEN' 的值。

基本使用方法

配置完成后，MCP 客户端（如 Claude 或 Cursor）将能够通过 MCP 协议与 unleash-mcp 服务器通信，并利用其提供的工具和资源来查询和管理 Unleash feature flag。

例如，在 Claude 或 Cursor 中配置好上述 'mcpServers' 后，你就可以指示 LLM 使用 'getFlag' 工具来查询特定的 feature flag 信息，或者使用 'listFlags' 工具来获取所有 feature flag 的列表。具体的工具和资源使用方法，请参考 unleash-mcp 项目的文档或工具/资源定义。

关键词