FlexPrice MCP服务器

FlexPrice MCP服务器是一个模型上下文协议(MCP)服务器,为AI助手(如Claude、Cursor、VS Code、Windsurf)提供FlexPrice API工具,用于管理客户、计划、价格、订阅、发票、付款、事件等。

  • by Random-test-v2
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 Random-test-v2/mcp-temp

使用说明

FlexPrice MCP服务器

模型上下文协议(MCP)服务器,将FlexPrice API公开为人工智能助手的工具(例如Claude、Cursor、VS Code、Windsurf)。使用它从IDE或CLI管理客户、计划、价格、订阅、发票、付款、事件等。

先决条件

  • Node.js v20或更高
  • npm 或 纱线
  • FlexPrice API密钥 从你的 FlexPrice账户

如何使用FlexPrice MCP服务器

您可以通过两种方式运行服务器: npm包 (一个命令)或 本地回购 (克隆并运行)。那就挑一个吧 将其添加到您的MCP客户端.


选项1:npm包

安装: npm i @omkar273/mcp-temp。或者使用一个命令运行(无克隆或构建):

npx @omkar273/mcp-temp start --server-url https://api.cloud.flexprice.io/v1 --api-key-auth YOUR_API_KEY

替换 YOUR_API_KEY 使用FlexPrice API密钥。下一页: 添加到您的MCP客户端.


选项2:本地回购

如果你想更改代码或不使用npm运行,请使用此命令:

  1. 克隆存储库并转到MCP服务器目录(例如。 api/mcp 或包含它的repo)。
  2. 安装依赖项: npm install
  3. 创建一个 .env 文件(来自 .env.example 如果存在),包括:
    • BASE_URL=https://api.cloud.flexprice.io/v1 (必须包括 /v1,没有尾随斜线)
    • API_KEY_APIKEYAUTH=your_api_key_here
  4. 构建: npm run build
  5. 开始: npm start

Docker(标准操作系统): 您还可以使用stdio构建和运行:

docker build -t flexprice-mcp .
docker run -i -e API_KEY_APIKEYAUTH=your_api_key_here -e BASE_URL=https://api.cloud.flexprice.io/v1 flexprice-mcp node bin/mcp-server.js start

下一页: 添加到您的MCP客户端 并使用 来自repo的节点 或 码头工人 配置如下。

添加到您的MCP客户端

在编辑器中添加FlexPrice MCP服务器。替换 YOUR_API_KEY 在所有示例中使用FlexPrice API密钥。

配置文件位置

主机 配置位置
光标 光标→ 设置→ MCP(或Cmd+Shift+P→ “光标设置”→ MCP)
VS Code 命令面板→ MCP:打开用户配置 (打开 mcp.json)
克劳德桌面(macOS) ~/Library/Application Support/Claude/claude_desktop_config.json
克劳德桌面(Windows) %APPDATA%\Claude\claude_desktop_config.json

光标

  1. 打开 光标→ 设置→ 光标设置 然后前往 主控程序 选项卡。
  2. 添加一个新的MCP服务器并使用此配置(选项1--npx):
{
  "mcpServers": {
    "flexprice": {
      "command": "npx",
      "args": [
        "-y",
        "@omkar273/mcp-temp",
        "start",
        "--server-url",
        "https://api.cloud.flexprice.io/v1",
        "--api-key-auth",
        "YOUR_API_KEY"
      ]
    }
  }
}

VS Code

  1. 打开命令选项板(Ctrl+Shift+P / Cmd+Shift+P)然后跑 MCP:打开用户配置 或 MCP:添加服务器.
  2. 添加:
{
  "servers": {
    "flexprice": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@omkar273/mcp-temp",
        "start",
        "--server-url",
        "https://api.cloud.flexprice.io/v1",
        "--api-key-auth",
        "YOUR_API_KEY"
      ]
    }
  }
}

克劳德代码

claude mcp add FlexPrice -- npx -y @omkar273/mcp-temp start --server-url https://api.cloud.flexprice.io/v1 --api-key-auth YOUR_API_KEY

然后运行 claude 和使用 /mcp 确认服务器已连接。


克劳德桌面版

添加到您的Claude Desktop配置文件(上表中的路径):

{
  "mcpServers": {
    "flexprice": {
      "command": "npx",
      "args": [
        "-y",
        "@omkar273/mcp-temp",
        "start",
        "--server-url",
        "https://api.cloud.flexprice.io/v1",
        "--api-key-auth",
        "YOUR_API_KEY"
      ]
    }
  }
}

退出并重新打开Claude Desktop。


替代配置

来自repo的节点 (选项2——从克隆仓库运行):

{
  "mcpServers": {
    "flexprice": {
      "command": "node",
      "args": ["/path/to/mcp-server/bin/mcp-server.js", "start"],
      "env": {
        "API_KEY_APIKEYAUTH": "your_api_key_here",
        "BASE_URL": "https://api.cloud.flexprice.io/v1"
      }
    }
  }
}

码头工人 (选项2-stdio):

{
  "mcpServers": {
    "flexprice": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-e", "API_KEY_APIKEYAUTH", "-e", "BASE_URL", "flexprice-mcp"],
      "env": {
        "API_KEY_APIKEYAUTH": "your_api_key_here",
        "BASE_URL": "https://api.cloud.flexprice.io/v1"
      }
    }
  }
}

编辑后,保存并 重新启动Cursor或退出并重新打开Claude Desktop 因此加载了MCP服务器。

工具

服务器将FlexPrice API操作公开为MCP工具。工具名称和参数遵循OpenAPI规范。有关完整列表,请参阅连接后MCP客户端的工具列表或OpenAPI规范(例如。 docs/swagger/swagger-3-0.json)在回购中。

渐进式发现(动态模式)

具有许多工具的服务器可能会增加上下文和令牌的使用量。 动态模式 公开了一小部分元工具,以便助手可以按需发现和调用操作:

  • list_tools –列出可用工具的名称和描述
  • describe_tool –获取一个或多个工具的输入模式
  • execute_tool –使用给定参数按名称运行工具

要启用动态模式,请添加 --mode dynamic 启动服务器时:

"args": ["-y", "@omkar273/mcp-temp", "start", "--server-url", "https://api.cloud.flexprice.io/v1", "--api-key-auth", "YOUR_API_KEY", "--mode", "dynamic"]

这减少了每个请求的令牌,并可以在有许多操作时改进工具选择。

范围

如果服务器配置了作用域(例如。 read, write),您可以按范围限制工具:

npx @omkar273/mcp-temp start --server-url https://api.cloud.flexprice.io/v1 --api-key-auth YOUR_API_KEY --scope read

使用 read 当服务器定义只读访问时 read 范围。

故障排除

“URL无效”或请求错误

  • 服务器从以下位置构建请求URL BASE_URL +路径。如果 BASE_URL 未设置或错误,请求失败。
  • 修复: 集 BASE_URL=https://api.cloud.flexprice.io/v1 (后面没有斜线 v1).对于npx,通过 --server-url https://api.cloud.flexprice.io/v1.
  • 如果你得到 404 在工具调用时,确保基本URL包括 /v1.

API连接问题

  1. 资格证书: 请检查您的API密钥和基本URL是否正确。使用FlexPrice API测试密钥(例如。 curl -H "x-api-key: your_key" https://api.cloud.flexprice.io/v1/customers).
  2. 网络: 确认主机可以访问FlexPrice API(防火墙、代理)。
  3. 速率限制: 如果您看到速率限制错误,请降低请求频率或联系FlexPrice支持。

服务器问题

  • 正在使用的端口: 如果其他进程使用该端口(例如3000),请更改服务器配置或停止其他进程。
  • 缺少依赖项: 跑 npm install 和 npm run build 在服务器目录中。
  • 权限: 确保入口点可执行(例如。 chmod +x bin/mcp-server.js).

码头工人

  • 构建失败: 检查Docker是否已安装,守护进程是否正在运行;尝试 docker build --no-cache.
  • 集装箱出口: 检查日志 docker logs <container_id>.
  • 环境变量: 验证是否传递了env: docker run -it --rm flexprice-mcp printenv.

生成MCP服务器

服务器是通过以下方式生成的 地下酒吧 来自OpenAPI规范(例如。 docs/swagger/swagger-3-0.json).在API或覆盖更改后重新生成:

  1. 安装 Speakeasy命令行界面.
  2. 从repo根目录运行MCP服务器的生成目标(例如。 make sdk-all 或输出到的Speakeasy工作流 api/mcp).
  3. 跑 make merge-custom 因此,自定义文件(包括此README)被合并到输出中。
  4. 构建并运行: npm run build 和 npm start 从MCP输出目录。

请参阅主仓库README和 代理商.md 用于SDK/MCP生成和发布。