Skip to main content
Glama
Sign In
pushbuild-mcp

pushbuild-mcp

Official
by pushbuild
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Describe an API

describe_api
Read-only

Retrieve the input schema and coverage details for a chosen public-data API, so you can confirm required parameters and data scope before calling it. No API key needed.

Instructions

Input parameters (JSON Schema) and coverage of one API id from search_apis. No key needed.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "api": "<api>"
    },
    "name": "describe_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiYesAPI id, e.g. restaurant-inspections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds genuinely new context: 'No key needed' discloses the auth requirement and it names what comes back (input parameters schema plus coverage) despite there being no output schema. It says nothing about behavior for invalid or unknown ids, response size, or how coverage is expressed.

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 short fragments, front-loaded with the return content and ending with the auth note; there is no filler. The clipped, verbless phrasing costs a little clarity, but nothing in it is wasted.

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

Completeness3/5

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

For a one-parameter read tool with annotations and no output schema, the description covers the essentials by naming what is returned and that no key is required. It stops short on edge behavior (unknown id, missing API) that an agent would otherwise have to discover by trial.

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 param already carries a documented example ('restaurant-inspections'), so the schema does the heavy lifting. The description only adds the provenance hint that ids originate from search_apis, which is mildly useful but not syntax or format detail.

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 identifies the resource (one API id) and the returned content (input parameters as JSON Schema plus coverage), and ties the input to search_apis. However, it is a verbless noun phrase ('Input parameters (JSON Schema) and coverage of one API id'), so the action is only implied by the title rather than stated, and it never mentions the other sibling, call_api.

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?

Saying the id comes 'from search_apis' implies the intended two-step workflow: search first, then describe. There is no explicit statement of when to use this instead of call_api, nor any exclusion or prerequisite beyond that implicit chain.

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

Deploy Server

Other Tools