Skip to main content
Glama
Free Live Data MCP

Free Live Data MCP

describe_endpoint

Read-onlyIdempotent

Inspect one live data API operation to view required parameters, allowed values, and defaults before calling it; use identifiers from user or lookup results.

Instructions

Inspect one operation, its required parameters, allowed values and defaults before calling it. Parameter identifiers must come from the user or source lookup results.

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": {
      "apiId": "<apiId>",
      "operationId": "<operationId>"
    },
    "name": "describe_endpoint"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiIdYes
operationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already establish that the tool is read-only, idempotent, non-destructive and closed-world. The description adds that it is meant to be used before calling an operation and that identifiers must come from the user or lookup results, but it does not describe return shape or any further behavioral constraints.

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?

The description is two short sentences, front-loads the core purpose, and contains no redundant or filler text. It is appropriately sized for a simple lookup tool.

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?

It explains what the tool inspects and where identifiers must come from, which is useful for a pre-call inspection tool. However, with no schema descriptions and no output schema, the description should do more to clarify the apiId and operationId inputs and the expected return information.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has zero description coverage for the two required parameters, apiId and operationId. The description says 'Parameter identifiers must come from the user or source lookup results', which gives provenance but does not explain the difference between apiId and operationId or their expected forms.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Inspect') and resource ('one operation') and states what information is returned: required parameters, allowed values and defaults. It implicitly distinguishes itself from call_endpoint by saying this is done 'before calling it', though it does not explicitly name the sibling tools.

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

Usage Guidelines4/5

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

It clearly frames the tool as a pre-call inspection step and adds that parameter identifiers must come from the user or lookup results. This gives useful usage context, but it does not explicitly say when to use search_endpoints instead of describe_endpoint.

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