金大哥 - schematic-mcp MCP 详情

article

README

🚀 原理图MCP服务器

这是一个 MCP 服务器，它将AI助手连接到原理图 —— 一个用于管理计费、套餐、功能和权限的平台。

使用此服务器，让Claude、Cursor或任何兼容MCP的客户端通过自然语言查找公司、管理套餐权限、设置覆盖规则、创建功能等。

🚀 快速开始

前提条件

获取原理图API密钥：注册原理图账户，并从原理图仪表盘获取API密钥。

📦 安装指南

选项1：使用Claude CLI（推荐）

从npm安装软件包：

npm i @schematichq/schematic-mcp

将MCP服务器添加到Claude：

claude mcp add --transport stdio --scope project schematic --env SCHEMATIC_API_KEY=your-api-key-here -- npx @schematichq/schematic-mcp

将 your-api-key-here 替换为你实际的原理图API密钥。

选项2：手动配置

Claude桌面版 / Claude代码版

添加到你的Claude配置文件（在macOS上为 ~/Library/Application Support/Claude/claude_desktop_config.json）：

{
  "mcpServers": {
    "schematic": {
      "command": "npx",
      "args": ["-y", "@schematichq/schematic-mcp"],
      "env": {
        "SCHEMATIC_API_KEY": "your-api-key-here"
      }
    }
  }
}

Cursor

添加到你的Cursor MCP配置文件（设置 > MCP服务器，或直接编辑文件）：

macOS：~/.cursor/mcp.json
Linux：~/.cursor/mcp.json
Windows：%USERPROFILE%\.cursor\mcp.json

{
  "mcpServers": {
    "schematic": {
      "command": "npx",
      "args": ["-y", "@schematichq/schematic-mcp"],
      "env": {
        "SCHEMATIC_API_KEY": "your-api-key-here"
      }
    }
  }
}

添加配置后，重启Cursor以使服务器生效。

📚 详细文档

配置

服务器需要一个原理图API密钥。它按以下顺序检查两个来源：

环境变量（推荐）：SCHEMATIC_API_KEY
配置文件（备用）：~/.schematic-mcp/config.json

{
  "apiKey": "your-api-key-here"
}

你可以在原理图仪表盘中找到你的API密钥。

💻 使用示例

工具

公司查找

| 属性 | 详情 | |------|------| | get_company | 通过ID、名称、Stripe客户ID或自定义密钥查找公司。返回详细信息、套餐、试用状态和链接。 | | get_company_plan | 获取公司当前使用的套餐。 | | get_company_trial_info | 检查公司是否处于试用期以及试用期何时结束。 | | count_companies_on_plan | 统计使用特定套餐的公司数量。 | | link_stripe_to_schematic | 根据Stripe客户ID查找原理图公司，反之亦然。 |

公司覆盖规则

| 属性 | 详情 | |------|------| | list_company_overrides | 按公司或功能列出覆盖规则。 | | set_company_override | 为公司的特定功能设置或更新覆盖规则。支持布尔值（on/off）、数值和 unlimited 值。 | | remove_company_override | 移除覆盖规则，使公司恢复到套餐权限。 |

套餐管理

| 属性 | 详情 | |------|------| | list_plans | 列出所有套餐。 | | create_plan | 创建新套餐。 | | add_entitlements_to_plan | 为套餐添加功能权限。自动检测功能类型并设置适当的值类型。 |

功能管理

| 属性 | 详情 | |------|------| | list_features | 列出所有功能。 | | create_feature | 创建新的功能标志。支持布尔型（开/关）、基于事件（计量）和基于特征的类型。自动创建关联标志。 |

示例提示

配置完成后，你可以尝试向AI助手提问：

"Acme Corp使用的是什么套餐？"
"列出我所有的套餐及其功能"
"创建一个名为 '高级分析' 的布尔型功能"
"为Acme Corp设置无限的API调用覆盖规则"
"有多少家公司使用专业版套餐？"
"查找与Stripe客户cus_abc123关联的原理图公司"

开发

# 安装依赖
yarn install

# 构建
yarn build

# 在开发模式下运行（更改时自动重新编译）
yarn dev

# 运行测试
yarn test

📄 许可证

本项目采用MIT许可证。

schematic-mcp