Ledger CLI MCP Server

by minhyeoky
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Used to set the LEDGER_FILE environment variable for configuring the path to the user's ledger file

mcp-server-ledger:Ledger CLI MCP 服务器

概述

一个模型上下文协议服务器,用于与Ledger CLI交互。Ledger CLI 是一个功能强大的复式记账系统,可通过命令行访问。该服务器允许大型语言模型通过 Ledger CLI 工具查询和分析您的财务数据。

该 MCP 服务器通过标准化接口公开 Ledger CLI 的功能,使 AI 助手可以轻松帮助您完成财务报告、预算分析和会计任务。

特征

服务器提供以下映射到 Ledger CLI 命令的工具:

  1. ledger_balance
    • 显示账户余额,并提供强大的过滤选项
    • 输入:查询模式、日期范围、显示选项
    • 返回:格式化的余额报告
  2. ledger_register
    • 显示交易记录及详细历史记录
    • 输入:查询模式、日期范围、排序选项
    • 返回:格式化的寄存器报告
  3. ledger_accounts
    • 列出分类账文件中的所有账户
    • 输入:可选查询模式
    • 返回:匹配账户列表
  4. ledger_payees
    • 列出交易的所有收款人
    • 输入:可选查询模式
    • 返回:匹配收款人列表
  5. ledger_commodities
    • 列出所有使用的商品(货币)
    • 输入:可选查询模式
    • 返回:匹配商品列表
  6. ledger_print
    • 以账本格式打印交易
    • 输入:查询模式、日期范围
    • 返回:格式化的分类帐条目
  7. ledger_stats
    • 显示有关分类帐文件的统计信息
    • 输入:可选查询模式
    • 返回:分类账的统计摘要
  8. ledger_budget
    • 显示预算分析
    • 输入:查询模式、日期范围、报告期
    • 返回:预算报告
  9. ledger_raw_command
    • 运行原始 Ledger CLI 命令
    • 输入:字符串列表形式的命令参数
    • 返回:以文本形式输出的命令

先决条件

  • 必须安装Ledger CLI并将其添加到你的 PATH 中
  • 包含您的财务数据的有效分类账文件

安装

使用 uv(推荐)

安装和运行此服务器的最简单方法是使用uv

uv sync

配置

服务器需要你的 Ledger 文件的路径。可以通过以下方式提供:

  • LEDGER_FILE环境变量
  • 启动服务器时的命令行参数

与 Claude Desktop 一起使用

将其添加到您的claude_desktop_config.json中:

"mcpServers": { "ledger": { "command": "uv", "args": [ "run", "--env-file", "/path/to/your/.env", // Optional: to set LEDGER_FILE "--with", "mcp[cli]", "mcp", "run", "<repo_path>/main.py" // Path to the main.py file in this repository ] } }

使用示例

配置完成后,您可以向 AI 助手询问有关您的财务数据的问题:

  • “显示我上个月的支出”
  • “我所有账户的当前余额是多少?”
  • “列出与亚马逊的所有交易”
  • “2023年我在食品杂货上花了多少钱?”
  • “显示我第一季度的预算表现”

AI 将通过服务器使用适当的 Ledger CLI 命令来获取信息。

调试

如需更详细的本地测试:

mcp dev main.py

发展

本服务器使用模型上下文协议 Python SDK构建。有关 MCP 以及如何开发 MCP 服务器的更多信息,请参阅官方文档

为该项目做出贡献:

  1. 克隆存储库
  2. 安装开发依赖项
  3. 进行更改
  4. 使用 MCP 检查器或与 Claude Desktop 集成进行测试

安全注意事项

此服务器会对您的财务数据运行 Ledger CLI 命令。虽然它包含防止命令注入的基本验证,但您仍应:

  • 仅与可信赖的客户一起使用
  • 注意公开的文件路径
  • 执行前检查所有命令

执照

此 MCP 服务器采用 MIT 许可证。您可以根据许可证条款自由使用、修改和分发它。

-
security - not tested
F
license - not found
-
quality - not tested

模型上下文协议服务器允许 AI 助手通过 Ledger CLI 查询和分析财务数据,从而实现财务报告、预算分析和会计等任务。

  1. Overview
    1. Features
      1. Prerequisites
        1. Installation
          1. Using uv (recommended)
        2. Configuration
          1. Using with Claude Desktop
        3. Usage Examples
          1. Debugging
            1. Development
              1. Security Considerations
                1. License
                  ID: rf9sps1ywe