Skip to main content
Glama
minhyeoky

Ledger CLI MCP Server

by minhyeoky

ledger_payees

Retrieve and filter payees from financial data using a regex pattern to streamline accounting and reporting tasks with the Ledger CLI MCP Server.

Instructions

List all payees

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Implementation Reference

  • main.py:198-205 (handler)
    The handler function for the 'ledger_payees' tool, registered via the @mcp.tool decorator. Executes the ledger 'payees' command with an optional query filter using the run_ledger helper.
    @mcp.tool(description="List all payees")
    def ledger_payees(params: LedgerPayees) -> str:
        cmd = ["payees"]
    
        if params.query:
            cmd.append(params.query)
    
        return run_ledger(cmd)
  • main.py:62-64 (schema)
    Pydantic BaseModel schema defining the input parameters for the ledger_payees tool: an optional query string to filter payees.
    class LedgerPayees(BaseModel):
        query: Optional[str] = Field(None, description="Filter payees by regex pattern")
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'List all payees' implies a read-only operation, but it doesn't specify if it requires authentication, how results are returned (e.g., pagination, format), or any rate limits. For a tool with zero annotation coverage, this is insufficient to inform safe and effective use.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with just three words, front-loaded to convey the core action immediately. There's no wasted language, making it efficient for quick understanding, though this brevity contributes to gaps in other dimensions.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (one parameter, no output schema, no annotations), the description is incomplete. It doesn't explain the parameter's role, the return format, or behavioral aspects like error handling. For even a basic tool, more context is needed to ensure the agent can invoke it correctly without guesswork.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description mentions no parameters, but the input schema has one parameter ('query') with 0% schema description coverage (the schema's description is generic). The description doesn't add any meaning beyond the schema, such as explaining what 'payees' are or how the 'query' filter works. With low coverage, it fails to compensate for the lack of schema details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'List all payees' clearly states the verb ('List') and resource ('payees'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'ledger_accounts' or 'ledger_register' which might also list things, and 'all' is somewhat vague about scope. This is adequate but has clear gaps in specificity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools or contexts where other tools might be more appropriate, such as using 'ledger_register' for transaction details or 'ledger_accounts' for account listings. This lack of comparative context leaves usage unclear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/minhyeoky/mcp-server-ledger'

If you have feedback or need assistance with the MCP directory API, please join our Discord server