Skip to main content
Glama

report api integration

report_api_integration
Read-only

Integration guide for any API with an OpenAPI spec: auth set-up, the key operations for your task, step-by-step plan, complete runnable code samples in your language with error handling and retries, pitfalls (pagination, rate limits, idempotency, webhooks) and a test plan, plus a PDF. If too few sources answer you are not charged (with async=true the core source is checked before the job is queued and charged). Costs $2 USDC per call (x402).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pdfNoInclude a 7-day PDF link (default true)
urlYes
taskNo
asyncNoReturn a job id now and the report later (the core source is checked first)
languageNo
webhook_urlNoWith async: POST the finished report here

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Beyond the readOnlyHint/openWorldHint annotations, the description discloses pricing ($2 USDC per call via x402), a no-charge guarantee when too few sources answer, and the async trade-off (core source pre-checked before the job is queued and billed). These are exactly the side-effect and cost signals an agent needs. Minor gap: it does not state expected latency or that a queued job is a server-side artifact, which sits slightly in tension with readOnlyHint.

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?

Two sentences, front-loaded with the artifact definition before the commercial/async caveats. Information density is high and every clause carries content, though the nested parenthetical about async charging is slightly hard to parse and could be split for clarity.

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 six-parameter tool with no output schema, the description adequately conveys what is returned (guide contents plus a PDF link) and how the async path behaves. Remaining gaps are modest: synchronous latency, output format beyond 'a report', and the exact string expected for the language parameter.

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?

Schema coverage is 50% (pdf, async, webhook_url documented; url, task, language bare). The description compensates by clarifying the three undocumented params: url is an OpenAPI spec, language drives the code samples, and task selects 'the key operations' in the plan. That is meaningfully above the baseline-3 expectation for a half-documented schema.

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 — 'Integration guide for any API with an OpenAPI spec' — and then enumerates the deliverable contents (auth set-up, key operations, step-by-step plan, runnable code samples, pitfalls, test plan, PDF). No sibling tool (e.g. openapi_inspect, report_repo) covers this same artifact, so an agent can select it without opening the schema.

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 'any API with an OpenAPI spec' precondition tells the agent what inputs qualify, and the async/no-charge clause hints at a fast-fail path. However, there is no explicit when-to-use vs alternatives guidance (e.g. versus openapi_inspect or contracts) and no stated prerequisites beyond the spec URL.

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