Skip to main content
Glama

DeveloperHub Docs

Read endpoint

read_endpoint
Read-only

Read one API endpoint as Markdown: its parameters, request body and responses, with the schemas they use. Pass its URL as list_endpoints gives it, with its #anchor.

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": {
      "url": "<url>"
    },
    "name": "read_endpoint"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesThe endpoint's URL, e.g. https://docs.example.com/api#create-user

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds genuine value by disclosing the return shape (endpoint parameters, request body, responses and the schemas they use, rendered as Markdown), which matters because there is no output schema. It stops short of describing failure behavior for invalid URLs or anchors.

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 the action and result, then the argument convention. No filler, no restating the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read tool with annotations covering safety and a description covering output content, this is largely complete. The only gap is error handling for a malformed or stale anchor, which is minor given openWorldHint=false implies a closed, static source.

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% and the schema example already shows a URL with an anchor. The description still adds meaning beyond it: that the value must come from list_endpoints and that the '#anchor' portion is required, not optional decoration.

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?

States a specific verb ('Read'), a precise resource ('one API endpoint'), and the output format as Markdown with the parameter/body/response/schema content included. The word 'one' plus the mention of list_endpoints distinguishes it from the listing sibling, though it does not explicitly contrast itself with read_page.

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?

It implies the workflow ('Pass its URL as list_endpoints gives it'), which is a useful routing cue to the listing tool. However, it never states when to choose this over read_page or list_sections, nor what happens with a wrong or missing anchor.

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