Skip to main content
Glama

afro.tools

Report Integration

report_integration
Read-onlyIdempotent

Builds a pre-filled GitHub link to report how an integration went against a spec — it worked, or the spec is wrong. Call it when the user confirms an integration works against the real API (sandbox or production), or when you find the spec does not match the API. Reports are how specs get verified and fixed. Nothing is posted: the user reviews the text and submits it on GitHub. One report per provider, covering every capability of the flow (e.g. payment init, status, webhook): each one is verified on its own.

Args:

  • provider (string): Provider slug e.g. "paycard"

  • capabilities (array): Every capability the integration used, each with its own result e.g. [{ "capability": "create_payment", "result": "worked" }, { "capability": "webhook", "result": "wrong: status is SUCCESSFUL, spec says succeeded" }]

  • summary (string): One line about the flow, e.g. "checkout flow works in sandbox"

  • details (string): What was called, what came back, what differed from the spec. NEVER include API keys, tokens, phone numbers or personal data.

  • tested_on (string?): Date of the test, YYYY-MM-DD

Returns: { url, next_step } — give the url to the user and follow next_step. If a spec does not exist: isError, with { error, available_capabilities } when the provider exists.

Input Schema

NameRequiredDescriptionDefault
detailsYesNo secrets or personal data
summaryYesOne line
providerYesProvider slug e.g. "paycard"
tested_onNoDate of the test, YYYY-MM-DD
capabilitiesYesEvery capability the integration used, each with its own result

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Although readOnlyHint/idempotentHint already signal safety, the description adds what the annotations cannot: "Nothing is posted: the user reviews the text and submits it on GitHub" — clarifying the human handoff. It also documents the failure mode ("If a spec does not exist: isError, with { error, available_capabilities }") and instructs on what to do with the returned url/next_step.

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?

The key behavior (build a link, nothing is posted) is front-loaded, then usage conditions, then parameters, then return shape — a sensible ordering. A few Args lines duplicate schema text verbatim (e.g. tested_on format), slightly diluting density.

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

Completeness5/5

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

For a tool with no output schema, the description fully covers the return contract ({ url, next_step } and the error shape with available_capabilities) as well as the agent's required follow-through. Nothing needed to invoke it correctly is absent.

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 100%, so the baseline is 3; the description earns a bump by supplying concrete examples for provider slug, capability objects, and result strings ("wrong: status is SUCCESSFUL, spec says succeeded"), plus an explicit PII/secret prohibition on details. The Args block largely restates the schema, so it is not a full 5.

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 opens with a specific verb and artifact: "Builds a pre-filled GitHub link to report how an integration went against a spec". This is clearly distinct from the sibling tools (get_spec, request_spec, search_specs), which retrieve or request specs rather than file verification reports.

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

Usage Guidelines5/5

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

It states exactly when to call: "when the user confirms an integration works against the real API (sandbox or production), or when you find the spec does not match the API". It also adds a scoping rule: "One report per provider, covering every capability of the flow... each one is verified on its own", which prevents the agent from splitting reports per capability.

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.