OpenLedger MCP 服务器

一个用于 OpenLedger API 的模型上下文协议 (MCP) 服务器实现。该服务器根据 MCP 规范为 AI 模型提供结构化上下文。

什么是 OpenLedger？

OpenLedger 是一个嵌入式会计 API，可将您客户的财务数据整合到您的平台中，从而创建一个单一的事实来源。它还可以用于通过 API 完全管理账本，使其非常适合 AI 代理。此 MCP 服务器允许像 Claude 这样的 AI 助手以结构化的方式与 OpenLedger API 交互。

什么是 MCP？

模型上下文协议 (MCP) 是为 AI 模型提供上下文的标准。它允许应用程序和 AI 模型之间进行结构化数据交换，从而实现更有效和上下文相关的 AI 交互。

在 modelcontextprotocol.io 了解更多信息。

特性

• 符合 MCP 的服务器实现
• 与 OpenLedger API 集成
• 用于财务数据的上下文感知 AI 交互
• 支持交易、公司和其他财务实体

快速开始

选项 1：本地安装

# 克隆仓库
git clone https://github.com/yourusername/Open-Ledger-MCP-Server.git
cd Open-Ledger-MCP-Server

# 安装依赖
bun install

# 设置环境变量
cp .env.example .env
# 编辑 .env 文件进行配置

# 启动服务器
bun start

选项 2：使用 Docker

# 克隆仓库
git clone https://github.com/yourusername/Open-Ledger-MCP-Server.git
cd Open-Ledger-MCP-Server

# 使用 Docker Compose 构建并运行
docker-compose up --build

# 或者使用提供的脚本
./docker-run.sh

与 Claude 一起使用

要将此 MCP 服务器与 Claude 一起使用，请将其添加到您的 Claude 配置中：

{
  "mcpServers": {
    "openledger": {
      "url": "http://localhost:8080/mcp"
    }
  }
}

有关如何将此服务器与 Claude 或其他支持模型上下文协议的 AI 助手一起使用的详细说明，请参阅 MCP_USAGE.md。

可用资源

OpenLedger MCP 服务器提供对以下资源的访问：

1. openledger://transactions - 访问和管理财务交易
2. openledger://companies - 访问和管理公司信息
3. openledger://categories - 访问和管理交易类别
4. openledger://reports - 生成财务报告

开发

# 以热重载的开发模式运行
bun dev

# 运行测试
bun test

# 构建用于生产
bun run build

项目结构

.
├── src/
│   ├── controllers/       # 请求处理程序
│   ├── routes/            # API 路由
│   ├── utils/             # 实用函数
│   └── index.ts           # 主应用程序入口点
├── .env.example           # 环境变量示例
├── docker-compose.yml     # Docker Compose 配置
├── Dockerfile             # Docker 配置
├── MCP_USAGE.md           # 与 Claude 一起使用的指南
├── package.json           # 项目依赖
├── README.md              # 此文件
├── run.sh                 # 用于本地运行的脚本
└── tsconfig.json          # TypeScript 配置

脚本

• run.sh - 一个用于安装依赖项并在本地启动服务器的 shell 脚本
• docker-run.sh - 一个用于在 Docker 容器中构建和运行服务器的 shell 脚本

许可证

有关详细信息，请参阅 LICENSE 文件。