Skip to main content
Glama

AgentLedger API Docs

ledger_api_docs
Read-onlyIdempotent

Self-serve documentation for AgentLedger — quickstart, MCP tools, REST endpoints, budget caps, error codes, and idempotency usage, as markdown.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNo"quickstart" | "mcp" | "rest" | "budget" | "errors" | "idempotency" | "metering" | "events" | "all" (default "" == "all"). Unknown topics fall back to the full docs.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / description
      Previous value: -"\"quickstart\" | \"mcp\" | \"rest\" | \"budget\" | \"errors\" | \"idempotency\" | \"all\"\n   (default \"\" == \"all\"). Unknown topics fall back to the full docs."New value: +"\"quickstart\" | \"mcp\" | \"rest\" | \"budget\" | \"errors\" | \"idempotency\" | \"metering\" | \"events\" | \"all\"\n   (default \"\" == \"all\"). Unknown topics fall back to the full docs."
  2. Changed1 schema field changed
    • changedInput schema / properties / topic / description
      Previous value: -"\"quickstart\" | \"mcp\" | \"rest\" | \"errors\" | \"idempotency\" | \"all\"\n   (default \"\" == \"all\"). Unknown topics fall back to the full docs."New value: +"\"quickstart\" | \"mcp\" | \"rest\" | \"budget\" | \"errors\" | \"idempotency\" | \"all\"\n   (default \"\" == \"all\"). Unknown topics fall back to the full docs."
  3. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered structurally. The description contributes the return format ('as markdown'), which is genuinely useful context beyond the annotations, but says nothing about size, pagination, or truncation of the fallback full-docs response.

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

Conciseness4/5

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

A single front-loaded sentence that leads with purpose and follows with the coverage list; no filler or redundant sentences. The inline enumeration is a little dense but earns its place by defining scope.

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

Completeness4/5

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

An output schema exists, so return-value structure need not be explained, and the annotation set covers the safety profile. For a low-complexity, no-required-param, read-only docs tool the description is essentially complete; only cross-tool routing guidance is missing.

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

Parameters3/5

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

Schema coverage is 100% and the single topic parameter is fully documented in the schema, including the default and the unknown-topic fallback. The description repeats the topic areas but adds no syntax or format detail beyond what the schema already provides, so the baseline 3 is appropriate.

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

Purpose4/5

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

The description names the tool's function (self-serve documentation) and enumerates the exact content areas it covers — quickstart, MCP tools, REST endpoints, budget caps, error codes, idempotency. An agent can immediately tell this is a documentation look-up tool. It does not, however, differentiate itself from doc-oriented siblings such as ledger_examples or read_skill, which likely also return prose/guidance.

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

Usage Guidelines3/5

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

Usage is only implied: the topic list signals the situations in which the tool is relevant, but there is no explicit when-to-use/when-not-to-use statement and no routing against the doc-adjacent siblings (ledger_examples, read_skill). Minimum-viable guidance rather than directive guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.