Skip to main content
Glama

list_api_catalog

Read-only

Discover every public HTTP API, registered MCP tool, and operation in the generated HelloBooks accounting API reference. Search/filter and follow nextPage for all results; pass id for full parameter/input-schema/response and authorization details. This returns documentation; authenticated accounting calls use company-scoped OAuth at the documented API host.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_api_catalog"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoReturn one entry with its complete input/schema/response details.
kindNo
pageNo
queryNoSearch name, operation, path, description or scope.
pageSizeNoDefault 50. Follow nextPage to enumerate every entry.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful behavior: results are paged via nextPage, the payload is documentation rather than live data, and id unlocks full schema and authorization details. It does not describe result shape, page-size governance, or how incomplete results appear when filters exclude kinds.

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?

Three sentences, front-loaded with the scope, then the operational procedure, then the documentation-vs-live-API caveat. No filler or restatement of the tool name.

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?

For a five-parameter read-only catalog tool with no output schema, the definition covers what the tool returns (entries, full details on id), how to enumerate everything (nextPage), and the boundary against authenticated calls. Only minor gaps remain around filter semantics for kind and page numbering.

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

Parameters4/5

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

With 60% schema coverage, the schema already documents id, query, and pageSize, and the description reinforces id's payoff ('its complete input/schema/response and authorization details') and the paging contract. It adds nothing about kind's enum values or page semantics, leaving that to the schema's self-evident naming.

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

Purpose5/5

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

The description states a specific verb and resource: 'Discover every public HTTP API, registered MCP tool, and operation in the generated HelloBooks accounting API reference.' The third sentence separates this catalog from live accounting operations ('This returns documentation; authenticated accounting calls use company-scoped OAuth at the documented API host'), which is exactly the distinction an agent needs to avoid confusing this with the sibling analysis/list tools.

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

Usage Guidelines4/5

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

It gives actionable procedure: 'Search/filter and follow nextPage for all results; pass id for full parameter/input-schema/response...' and clarifies that actual accounting calls belong elsewhere. What is missing is an explicit when-to-use trigger (e.g., 'call this first to resolve an endpoint before invoking it') and any when-not-to-use exclusions beyond the documentation-vs-live-data note.

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.

Resources