Lithic MCP Server 使用说明

项目简介

Lithic MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它允许LLM应用安全地访问 Lithic API 的银行和卡服务。该服务器提供只读访问，通过工具的方式暴露 Lithic API 的各项资源，例如卡片、账户、交易等。你可以将其配置到支持 MCP 协议的 LLM 客户端（如 Cursor 编辑器或 Claude 桌面应用）中，以增强 LLM 的上下文感知能力，使其能够利用 Lithic 的金融数据进行更智能的交互。

主要功能点

资源访问: 提供对 Lithic API 各种金融资源的只读访问能力，包括卡片、账户、交易、事件、余额等。
工具集成: 预置 'get_resource' 和 'list_resources' 两个工具，方便 LLM 客户端获取指定 ID 的资源或列出特定类型的资源。
标准化协议: 基于 MCP 协议开发，确保与支持该协议的 LLM 客户端的兼容性和互操作性。
Docker 部署: 提供 Docker 镜像，简化部署和运行过程。
环境配置: 通过环境变量灵活配置 Lithic API 密钥和基础 URL。

安装步骤

Docker 部署 (推荐):

构建 Docker 镜像: 打开终端，进入仓库根目录，执行以下命令构建 Docker 镜像：
```
npm run docker:build
```
运行服务器: 设置 'LITHIC_API_KEY' 环境变量，然后运行 Docker 镜像启动服务器：
```
LITHIC_API_KEY=your_key_here npm run docker:run
```
请将 'your_key_here' 替换为你的 Lithic API 密钥。

手动安装:

安装依赖: 在仓库根目录执行以下命令安装项目依赖：
```
npm install
```
构建 TypeScript 代码: 执行以下命令编译 TypeScript 代码：
```
npm run build
```
启动服务器: 设置 'LITHIC_API_KEY' 环境变量，然后运行以下命令启动服务器：
```
LITHIC_API_KEY=your_key_here npm start
```
同样，请将 'your_key_here' 替换为你的 Lithic API 密钥。

服务器配置

要将 Lithic MCP Server 集成到 MCP 客户端，你需要配置客户端的 MCP 设置。以 '.cursor/mcp.json' 或 Claude Desktop 配置为例，添加如下 JSON 配置：

{
  "lithic": {
    "command": "docker",
    "args": [
      "run",
      "--rm",
      "-i",
      "-e", "LITHIC_API_KEY",
      "-e", "LITHIC_API_BASE_URL",
      "mcp/lithic"
    ],
    "env": {
      "LITHIC_API_KEY": "your_lithic_api_key_here", // 请替换为你的 Lithic API 密钥
      "LITHIC_API_BASE_URL": "https://api.lithic.com/v1" // 可选: Lithic API 基础 URL，默认为沙箱环境 https://sandbox.lithic.com/v1
    }
  }
}

配置参数说明:

'"lithic"': 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。
'"command": "docker"': 指定启动服务器的命令为 'docker'，如果你选择手动安装，可以将 'command' 修改为 'node'，'args' 修改为 '["dist/index.js"]'。
'"args": [...]': 启动命令的参数列表。
- '"run", "--rm", "-i"': Docker 运行参数，'--rm' 表示容器退出后自动删除，'-i' 表示保持标准输入打开。
- '"-e", "LITHIC_API_KEY"': 通过环境变量传递 Lithic API 密钥。
- '"-e", "LITHIC_API_BASE_URL"': 通过环境变量传递 Lithic API 基础 URL。
- '"mcp/lithic"': Docker 镜像名称。
'"env": {...}': 环境变量配置。
- '"LITHIC_API_KEY": "your_lithic_api_key_here"': 必须配置，请替换为你的真实 Lithic API 密钥。
- '"LITHIC_API_BASE_URL": "https://api.lithic.com/v1"': 可选配置，Lithic API 基础 URL，默认为 'https://sandbox.lithic.com/v1' (沙箱环境)。如果你需要连接到生产环境，请修改为相应的 URL。

注意: 请务必将 '"your_lithic_api_key_here"' 替换为你自己的 Lithic API 密钥。密钥泄露可能导致安全风险。

基本使用方法

配置完成后，在支持 MCP 的 LLM 客户端中，你可以使用 'get_resource' 和 'list_resources' 两个工具来访问 Lithic API 数据。

工具列表:

'get_resource': 获取指定 ID 的 Lithic 资源。

参数:
- 'resourceType': 资源类型 (例如: 'card', 'account', 'transaction' 等)。
- 'resourceId': 资源 ID 或 token。

示例: 获取 ID 为 '12345' 的卡片信息。

{
  "tool_calls": [
    {
      "id": "tool_call_id",
      "type": "function",
      "function": {
        "name": "get_resource",
        "arguments": "{\"resourceType\": \"card\", \"resourceId\": \"12345\"}"
      }
    }
  ]
}

'list_resources': 列出指定类型的 Lithic 资源。

参数:
- 'resourceType': 资源类型 (例如: 'card', 'account', 'transaction' 等)。

示例: 列出所有卡片信息。

{
  "tool_calls": [
    {
      "id": "tool_call_id",
      "type": "function",
      "function": {
        "name": "list_resources",
        "arguments": "{\"resourceType\": \"card\"}"
      }
    }
  ]
}

LLM 客户端会将工具调用结果返回给你，结果通常是 JSON 格式的 Lithic API 响应数据。你可以根据这些数据进行后续的 LLM 应用开发。

关键词