ironxyz

get-api-specs

Read-only

Retrieve detailed API endpoint specifications including parameters, request/response schemas, and examples. Use to understand an endpoint before code generation or direct invocation.

Instructions

Get detailed specifications for a specific API endpoint including parameters, request/response schemas, and examples. Should be used to get a deeper understanding of an API endpoint you will use for code generation or for real API invoking. In case you intend to use the invoke-api-endpoint MCP tool, ALWAYS use this before, so you understand the full context of an API.

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": {
      "path": "<path>",
      "method": "<method>"
    },
    "name": "get-api-specs"
  }
}

Input Schema

Name	Required	Description	Default
`path`	Yes	The API endpoint path — use the template form from list-all-endpoints (e.g., '/customers', '/identifications/{id}') or a resolved path (e.g., '/identifications/abc123')
`method`	Yes	HTTP method

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.2.0May 29, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, so the description's burden is lower. It adds context that the tool returns parameters, schemas, and examples, which is helpful beyond the annotation.

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?

Two sentences, front-loaded with purpose, then usage guidance. No redundant information.

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?

Tool is a read-only spec retrieval. Annotations cover safety, schema covers parameters, description covers purpose and usage. No output schema but description states what is returned. Complete for its role.

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% with detailed descriptions for both parameters. The description does not add additional meaning beyond what the schema provides, so baseline of 3 is appropriate.

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?

Description clearly states 'Get detailed specifications for a specific API endpoint including parameters, request/response schemas, and examples.' The verb 'get' and resource 'specifications' are precise. It distinguishes from sibling 'list-all-endpoints' by focusing on a single endpoint, and from 'invoke-api-endpoint' by being informational.

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?

Explicitly states 'Should be used to get a deeper understanding...' and 'ALWAYS use this before' invoking the API endpoint tool. This provides clear when-to-use guidance and differentiates from siblings.

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

Deploy Server