Unleash Feature Flag MCP Server 使用说明

项目简介

Unleash Feature Flag MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用，旨在桥接 AI 助手与 Unleash 特性开关管理系统。通过此服务器，AI 助手能够理解并执行与 Unleash 功能开关相关的自然语言指令，例如查询、创建、更新特性开关等，从而实现更智能化的功能发布和管理流程。

主要功能点

项目管理: 获取 Unleash 中所有项目的列表。
特性开关管理:
- 获取指定项目下的所有特性开关。
- 创建新的特性开关到指定项目。
- 更新现有特性开关的属性（如描述、类型等）。
- 获取指定特性开关的详细信息。

安装步骤

确保你的开发环境中已安装 Node.js 和 npm。

全局安装 '@ylin6/unleash-ff-mcp-server' 包：

npm install -g @ylin6/unleash-ff-mcp-server

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

要使 MCP 客户端（如 Cursor 等）能够连接并使用此 MCP 服务器，你需要提供以下配置信息。请将以下 JSON 配置添加到你的 MCP 客户端配置中，并根据你的 Unleash 实例信息进行修改。

{
  "serverName": "unleash-ff-mcp-server",
  "command": "npx",
  "args": [
    "@ylin6/unleash-ff-mcp-server"
  ],
  "env": {
    "UNLEASH_API_URL": "YOUR_UNLEASH_API_URL",  // 替换为你的 Unleash API 地址，例如：https://unleash.example.com/api
    "UNLEASH_AUTH_TOKEN": "YOUR_UNLEASH_AUTH_TOKEN" // 替换为你的 Unleash API 认证 Token
  }
}

配置参数说明:

'serverName': MCP 服务器的名称，可以自定义，用于在 MCP 客户端中标识该服务器。
'command': 启动 MCP 服务器的命令，这里使用 'npx' 来运行全局安装的 '@ylin6/unleash-ff-mcp-server'。
'args': 传递给 'command' 的参数，此处为空数组。
'env': 环境变量配置，用于配置 Unleash API 的连接信息：
- 'UNLEASH_API_URL': 必填，你的 Unleash API 服务的 URL 地址。
- 'UNLEASH_AUTH_TOKEN': 必填，用于 API 鉴权的 Unleash 认证 Token。

请务必将 'YOUR_UNLEASH_API_URL' 和 'YOUR_UNLEASH_AUTH_TOKEN' 替换为你实际的 Unleash API 地址和认证 Token。

基本使用方法

完成上述配置后，在你的 MCP 客户端中，即可通过自然语言指令来操作 Unleash 的特性开关。例如，你可以向 AI 助手发出类似以下的指令：

"列出所有项目"
"显示 'dashboard' 项目的所有特性开关"
"创建一个名为 'new-feature' 的特性开关在 'marketing' 项目中，用于 'A/B 测试新落地页'"
"更新特性开关 'new-feature' 的描述为 '优化后的新落地页 A/B 测试'"

AI 助手会解析你的指令，并调用 Unleash Feature Flag MCP Server 提供的工具来执行相应的操作，并返回结果。

示例对话:

用户:  请显示 '产品功能' 项目下的所有特性开关。
AI助手:  正在获取 '产品功能' 项目的特性开关...
[AI助手调用 getFeatures 工具，projectId='产品功能']
AI助手:  以下是 '产品功能' 项目的特性开关列表：
- user-onboarding (类型: release)
- dark-theme (类型: experiment)
- pricing-page-v2 (类型: operational)
...

通过这种方式，你可以利用 AI 助手以更便捷、自然的方式管理你的 Unleash 特性开关。

关键词