README
🚀 石 lithic MCP 服务器(TypeScript)
本项目是一个使用 TypeScript 实现的 Lithic API 的模型上下文协议 (MCP) 服务器,为用户提供对 Lithic 银行和卡服务的只读访问,有效满足相关数据查看需求。
✨ 主要特性
- 采用 MCP SDK 的现代 TypeScript 实现,紧跟技术潮流。
- 对所有 Lithic API 端点提供只读访问,保障数据安全。
- 具备类型安全工具,用于访问 Lithic 资源,提升开发效率。
- 支持 Docker,方便部署与管理。
- 拥有改进的错误处理和验证机制,增强系统稳定性。
🚀 快速开始
使用 Docker(推荐)
- 构建 Docker 镜像:
npm run docker:build
- 运行服务器:
LITHIC_API_KEY=your_key_here npm run docker:run
手动设置
- 安装依赖项:
npm install
- 构建 TypeScript 代码:
npm run build
- 启动服务器:
LITHIC_API_KEY=your_key_here npm start
📚 详细文档
MCP 配置
将以下内容添加到你的 .cursor/mcp.json 或 Claude 桌面配置中:
{
"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_BASE_URL": "https://api.lithic.com/v1"
}
}
}
可用工具
此 MCP 服务器提供以下工具:
get_resource:按 ID/令牌获取特定的 Lithic 资源。list_resources:列出指定类型的资源。
环境变量
| 属性 | 详情 |
|------|------|
| LITHIC_API_KEY | 你的 Lithic API 密钥(必需) |
| LITHIC_API_BASE_URL | Lithic API 基础 URL(默认:https://sandbox.lithic.com/v1) |
支持的资源类型
- 卡
- 账户
- 财务账户
- 交易
- 事件
- 余额
- 纠纷
- 外部银行账户
- 报告
- 回调
- 账户持有者
开发
对于开发,你可以使用观察模式:
npm run dev
这将自动重建并在你更改源代码时重新启动服务器。
Scan to join WeChat group