使用说明内容（Markdown格式）

项目简介

Griffin API MCP服务器是一套基于 MCP（Model Context Protocol）的后端服务，旨在把 Griffin 的银行相关数据、操作工具以及提示模板以标准化的方式暴露给对话式 AI 客户端。通过 JSON-RPC 与客户端通信，服务器提供资源管理、工具执行和提示渲染能力，方便强提示和自定义交互场景的实现。

主要功能点

• 资源与数据访问：提供对 Griffin API 的银行账户、法人与实体、交易、支付等资源的查询与获取能力。
• 工具执行：定义并注册一组工具，允许 LLM 调用外部 Griffin API 完成创建支付、打开/关闭账户、列出账户等操作。
• 提示模板：内置并注册对话模板，支持可定制的提示输入与对话引导，帮助实现可控的对话流程。
• JSON-RPC 通信：客户端通过标准的 MCP JSON-RPC 请求与服务器通信，获取结果或触发操作。
• 会话与安全：实现会话管理与能力声明，适配多种传输协议（如 STDIO），并建议在沙箱模式下使用 API Key 进行调用。
• 依赖成熟的 MCP 框架：使用 @modelcontextprotocol/sdk 的 MCP 服务组件，确保与主流 MCP 客户端的互操作性。

安装步骤

• 环境要求
  • Node.js 16 及以上
  • npm 7 及以上
• 获取依赖与编译（若直接以包方式运行，见下一步的服务器配置）
  • 通过包管理工具安装所需依赖（在项目根目录执行安装命令）
• 启动方式
  • 本服务器示例通过标准输入输出（STDIO）传输与 MCP 客户端通信。运行时请在环境中提供 Griffin API 的密钥。
  • 常见运行方式是使用 npx 安装并执行 MCP 服务器包，例如：
    • npx -y @griffinbank/mcp-server
  • 启动前需配置环境变量，例如：
    • GRIFFIN_API_KEY=your-griffin-api-key
    • GRIFFIN_API_BASE_URL=https://api.griffin.com（可选，默认为 Griffin 公共 API 地址）
  • 如果是在 Claude Desktop 等客户端集成场景中，按客户端的配置指引将上述启动信息写入配置即可。

服务器配置（供 MCP 客户端参考，客户端实际配置若直接使用命令行启动即可）

以下为该服务器在 MCP 客户端配置中需要的信息示例（为帮助理解，按文本形式给出，非代码块）： { "serverName": "Griffin API", "command": "npx", "args": ["-y", "@griffinbank/mcp-server"], "env": { "GRIFFIN_API_KEY": "your-griffin-api-key", "GRIFFIN_API_BASE_URL": "https://api.griffin.com" } }

说明

• serverName 对应 MCP 服务的对外名称，建议与实际部署保持一致，以便在客户端界面清晰展示。
• command 与 args 指定服务器启动命令及参数，客户端据此能够自动发起连接。
• env 提供运行所需的环境变量，GRIFIN_API_KEY 必填，用于鉴权 Griffin API 调用；GRIFFIN_API_BASE_URL 可选，默认为 Griffin 的公开 API 地址。

基本使用方法

• 客户端配置完成后，客户端将通过 MCP JSON-RPC 与服务器建立连接，后续对 Griffin API 的查询、列表、创建和提交等操作将在对话中被调用。
• 使用前请确保已在 Griffin 官网申请并配置沙箱（Sandbox）环境的 API Key，以避免误用生产密钥。
• 首次运行时，服务器会对可用工具进行注册并暴露相应的查询与执行能力，LLM 任务可以通过提示模板来触发这些工具的调用。
• 如需扩展，请在代码中添加新的工具、资源查询或提示模板，并重新启动 MCP 服务器以使变更生效。