项目简介
基于 Creem API SDK 构建的 MCP 服务器实现。它将 Creem API 提供的 SaaS 订阅和收入管理功能封装为标准化工具,使大型语言模型 (LLM) 应用能够轻松访问和利用这些业务能力。
主要功能点
- 资源访问: 通过 MCP 服务器,LLM 可以访问和管理 Creem API 中的产品、客户、订阅、交易、折扣和许可等数据资源。
- 工具调用: 将 SDK 中提供的各种 API 方法(如检索产品、创建结算会话、管理订阅等)暴露为可由 LLM directly 调用的工具。
- 标准化交互: 支持基于 JSON-RPC 协议的 MCP 标准通信,方便与遵循 MCP 规范的 LLM 客户端集成。
安装步骤
该 MCP 服务器功能包含在 'creem' npm 包中。使用以下任一包管理器安装即可:
npm add creem
pnpm add creem
bun add creem
yarn add creem zod # 注意:Yarn 需要手动安装 peer dependency 'zod'
服务器配置
MCP 服务器需要由 LLM 客户端配置并启动。以下是配置示例,通常以 JSON 格式添加到 LLM 客户端的配置文件中(例如 Claude Desktop 的 'claude_desktop_config.json' 或 Cursor 的 '.cursor/mcp.json'):
{ "mcpServers": { "Creem": { "command": "npx", "args": ["-y", "--package", "creem", "--", "mcp", "start"] } } }
参数说明:
- '"Creem"': 您为该 MCP 服务器指定的名称,在 LLM 客户端中用于引用此服务器。
- '"command"': 启动 MCP 服务器的可执行命令。这里使用 'npx' 来执行已安装的 'creem' 包中的 'mcp' 命令。
- '"args"': 传递给 'command' 的参数列表。'-y --package creem' 确保使用 'creem' 包中的命令,'-- mcp start' 则是实际启动 MCP 服务器的命令和参数。
(注意:具体的配置文件路径和格式取决于您使用的 MCP 客户端,请查阅客户端文档。)
基本使用方法
配置完成后,您的 LLM 客户端将能够通过 MCP 协议发现并连接到 "Creem" 服务器。LLM 可以通过服务器提供的工具来执行操作,例如:
- 请求服务器调用 'retrieveProduct' 工具,并提供产品 ID 和 API Key,以获取特定产品信息。
- 请求服务器调用 'createCheckout' 工具,提供必要的产品 ID 和客户信息,以创建新的结算会话链接。
- 请求服务器调用 'searchTransactions' 工具,提供过滤条件如客户 ID 或产品 ID,以查询相关交易记录。
LLM 会以 JSON-RPC 请求的形式发送工具调用指令,服务器执行相应的 Creem API 调用后,将结果以 JSON-RPC 响应的形式返回给 LLM。整个过程无需 LLM 直接处理 HTTP 请求或 API 细节。
信息
分类
商业系统