使用说明

项目简介

OpenLedger MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它作为 OpenLedger API 的桥梁，为大型语言模型 (LLM) 提供结构化的金融数据上下文。通过此服务器，LLM 可以安全、标准地访问和操作 OpenLedger 提供的财务信息，例如交易记录、公司信息和财务报告等，从而实现更智能的金融应用集成。

主要功能点

MCP 协议兼容: 完全遵循 Model Context Protocol 规范，确保与任何兼容 MCP 协议的 LLM 客户端（如 Claude）无缝对接。
OpenLedger API 集成: 深度集成 OpenLedger API，将底层的金融数据转化为结构化的资源和动作，方便 LLM 理解和调用。
结构化上下文提供: 以标准化的方式向 LLM 提供财务上下文信息，包括交易、公司、分类和报告等资源及其相应的操作。
数据访问能力: 提供对 OpenLedger 财务数据的读取和管理能力，例如获取交易记录、公司详情、分类信息等。
可扩展性: 基于 Express.js 框架构建，易于扩展和维护，可以根据需求添加新的资源和功能。

安装步骤

方式一：本地安装

克隆仓库:

git clone https://github.com/openledger/Open-Ledger-MCP-Server.git
cd Open-Ledger-MCP-Server

安装依赖:
```
bun install
```
配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，然后根据需要编辑 '.env' 文件，例如配置端口号等。
```
cp .env.example .env
# 编辑 .env 文件
```
启动服务器:
```
bun start
```

方式二：使用 Docker

克隆仓库:

git clone https://github.com/openledger/Open-Ledger-MCP-Server.git
cd Open-Ledger-MCP-Server

构建并运行 Docker 容器:

docker-compose up --build

或者使用提供的脚本：

./docker-run.sh

服务器配置

对于 MCP 客户端（例如 Claude），您需要配置 MCP 服务器的连接信息。以下是一个 JSON 格式的配置示例，您需要将其添加到您的 MCP 客户端配置中。

{
  "serverName": "openledger",  // MCP 服务器的名称，可以自定义
  "url": "http://localhost:8080/mcp" // MCP 服务器的 URL 地址，默认为本地 8080 端口的 /mcp 路径
}

配置参数说明:

'serverName': 服务器名称，用于在客户端中标识和引用该服务器。您可以自定义名称，例如 "openledger"。
'url': MCP 服务器的根 URL。客户端将向此 URL 发送 MCP 请求。默认情况下，服务器运行在 'http://localhost:8080'，MCP 协议端点为 '/mcp'，因此完整的 URL 是 'http://localhost:8080/mcp'。如果您更改了服务器端口或路径，请相应地更新此 URL。

基本使用方法

启动服务器: 根据上述安装步骤启动 OpenLedger MCP Server。
配置 MCP 客户端: 在您的 MCP 客户端（例如 Claude）中，添加上述提供的服务器配置 JSON。确保客户端能够访问到服务器的 URL 地址。
使用 LLM 客户端与 OpenLedger 数据交互: 现在您可以使用支持 MCP 协议的 LLM 客户端，通过配置的 "openledger" 服务器名称，访问 OpenLedger 提供的资源和功能。例如，您可以指示 LLM 客户端从 "openledger://transactions" 资源获取交易数据，或调用 "openledger://companies" 资源下的操作来管理公司信息。

请参考 'MCP_USAGE.md' 文件以获取更详细的使用指南和示例。

关键词