Skip to main content
Glama

DeveloperHub Docs

List endpoints

list_endpoints
Read-only

List the endpoints of one API reference (method, path and summary), grouped by tag, each linked by the URL read_endpoint takes.

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": {
      "reference": "<reference>"
    },
    "name": "list_endpoints"
  }
}

Input Schema

NameRequiredDescriptionDefault
versionNoA version slug from list_versions. Leave it out for the default version.
referenceYesThe API reference's slug, from list_sections

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful behavior beyond that — the result is grouped by tag and each entry is linked to the URL read_endpoint accepts — which matters because there is no output schema. It still says nothing about pagination, completeness of the listing, or auth requirements, so it adds context without fully characterizing behavior.

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 with the resource and scope front-loaded, followed by the returned fields and the cross-tool linkage. Every clause carries information and there is no filler.

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 two-parameter read-only listing tool with no output schema, the description covers what is returned and how it is organized, which is the main thing an agent cannot get from structured fields. Missing pagination and total-count behavior keeps it from a 5.

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 description coverage is 100%, and the schema itself explains that reference comes from list_sections and version from list_versions, with version optional for the default. The description adds no parameter meaning beyond that, so the baseline of 3 applies.

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 and resource ('List the endpoints of one API reference') and states the scope and returned fields (method, path, summary). It also ties the output to the sibling read_endpoint, so an agent can infer this is the discovery step before reading a single endpoint. It stops short of explicitly saying which sibling to use when searching rather than browsing, keeping it at 4 rather than 5.

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?

Usage is only implied: the reader learns endpoints belong to a reference and that read_endpoint consumes the resulting URL, which suggests a browse-then-read flow. There is no explicit when-to-use or when-not-to-use guidance versus search or list_pages, and no stated prerequisites beyond what the schema says about sourcing slugs.

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