Skip to main content
Glama
inavi-systems

inavi-mcp

Official

Get iNavi Maps API Specification

get_api_spec

Retrieve complete API specification with request/response schemas by providing an operationId. Get parameters, request body, and response schemas for any API.

Instructions

Retrieves detailed specification of a specific API (including request/response schemas). PREREQUISITE: First use list_api_specs to browse available APIs and obtain the operationId. USAGE: Provide an operationId to get the complete API specification including parameters, request body, and response schemas. NOTE: All $ref references have already been dereferenced to actual schema contents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationIdYesUnique identifier of the API to retrieve (e.g., getRouteTimeResult)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAPI path
tagsYesAPI category tags
methodYesHTTP method
baseUrlYesBase URL
summaryYesBrief API description
categoryYesAPI category (route, search)
responsesYesResponse schemas by status code
deprecatedNoWhether the API is deprecated
parametersNoList of API parameters
descriptionYesDetailed API description
operationIdYesUnique API identifier
requestBodyNoRequest body schema

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.4.1
    • addedOutput schema / properties / parameters / items / additionalProperties
      Added value: +true
    • addedOutput schema / properties / parameters / items / properties
      Added value: +{}
    • addedOutput schema / properties / parameters / items / type
      Added value: +"object"
    • addedOutput schema / properties / requestBody / additionalProperties
      Added value: +true
    • addedOutput schema / properties / requestBody / properties
      Added value: +{}
    • addedOutput schema / properties / requestBody / type
      Added value: +"object"
    • addedOutput schema / properties / responses / additionalProperties / additionalProperties
      Added value: +true
    • addedOutput schema / properties / responses / additionalProperties / properties
      Added value: +{}
    • addedOutput schema / properties / responses / additionalProperties / type
      Added value: +"object"
  2. Changed2 schema fields changedv0.3.10
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
  3. First observedv0.3.9

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description must carry the behavioral burden. It does well by explaining this is a retrieval operation and disclosing that all $ref references are dereferenced. It does not explicitly state there are no side effects, but 'retrieves' strongly implies a read-only operation.

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 description is compact and scannable with clear PREREQUISITE, USAGE, and NOTE sections. There is slight redundancy between 'Retrieves detailed specification' and 'complete API specification', but every sentence contributes useful 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?

For a single-parameter tool with an output schema, the description covers the necessary predecessor step, what input to provide, and what the response will contain. No critical operational detail is missing.

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 adds value beyond the schema by explaining that operationId comes from list_api_specs and is the key to selecting a complete API specification.

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 uses a specific verb and resource: 'Retrieves detailed specification of a specific API'. It clearly differentiates from sibling tools by requiring an operationId and referencing list_api_specs as the prerequisite browsing step.

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?

The description explicitly states a PREREQUISITE ('First use list_api_specs to browse available APIs and obtain the operationId') and a USAGE ('Provide an operationId'), making the correct call flow and tool selection unambiguous.

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