Skip to main content
Glama

Describe a vendor API endpoint

vendor_endpoint
Read-only

Describes one vendor endpoint's inputs, example values, paging or unit quirks, and required credentials so callers can prepare before calling it.

Instructions

Describe one vendor endpoint: every input with where it goes and an example, the notes a caller gets wrong without (units, paging, quirks), and the credentials it needs. Read it before 'call_vendor'.

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": {
      "endpoint": "<endpoint>"
    },
    "name": "vendor_endpoint"
  }
}

Input Schema

NameRequiredDescriptionDefault
endpointYesThe endpoint id, '<vendor>.<job>', as 'vendors' lists it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.13.0

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered structurally; the description earns credit for disclosing the shape of the returned knowledge (per-input destinations, examples, units/paging quirks, credential requirements). It stops short of saying whether the output is paginated or how large it can be, which is a minor residual gap for a documentation-style read.

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?

One dense sentence enumerating the three content classes, followed by a one-clause usage instruction. Every clause carries information and the core purpose is front-loaded before the routing advice.

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 covering safety, the description is largely sufficient and does describe what comes back in place of an output schema. However, it never states that the endpoint must be called before call_vendor will succeed (only that it should be read first), nor how invalid ids are surfaced — small but real gaps for a prerequisite tool.

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 'endpoint' parameter already documents the '<vendor>.<job>' format and that 'vendors' enumerates valid ids. The description adds no further param meaning, so the baseline 3 applies — the schema, not the prose, does the work here.

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 ("Describe") and a specific resource ("one vendor endpoint"), then enumerates the payload: inputs with destinations and examples, caller gotchas (units, paging, quirks), and credentials. That is concrete enough to distinguish it from call_vendor and from catalog tools like 'vendors' without opening any schema.

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 closing directive "Read it before 'call_vendor'" gives an explicit prerequisite and names the sibling it gates, so an agent knows both when to reach for this tool and what it is upstream of. It doesn't spell out exclusions, but the sequencing rule alone removes the main routing ambiguity.

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