Skip to main content
Glama

BRAINIAC API catalog

Describe endpoint

describe_endpoint

Return the input schema, example, path, and price for one paid endpoint. This does not run the endpoint.

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

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does deliver the single most important trait: this is a non-executing, side-effect-free inspection that won't trigger the paid call. It says nothing about auth requirements, whether the describe call itself is free, or what happens with an invalid or unaffordable endpoint id.

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 short sentences, front-loaded with the return payload and closed with the one behavioral caveat that matters. Nothing superfluous.

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 lookup with no output schema, listing the returned fields is helpful, but the definition omits how to obtain the id and any note on pricing semantics or failure modes. Adequate but with a clear gap on the only input.

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 single parameter 'id' has 0% schema description coverage, so the description must compensate and does not: it never says the id identifies a paid endpoint, nor where to obtain one (list_apis/search_endpoints). An agent is left guessing the id format and provenance.

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?

States a specific verb and resource (return metadata for one paid endpoint) and enumerates exactly what comes back: input schema, example, path, and price. The closing clause 'This does not run the endpoint' separates it from the call_endpoint sibling without needing the schema.

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?

The negative guidance ('does not run the endpoint') implies this is the inspect-before-invoke tool, but it never says when to prefer it over list_apis or search_endpoints, nor that the id should come from a discovery call. Usage is inferable but not stated.

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.

Resources