Skip to main content
Glama

endpoint_by_id

Read-onlyIdempotent

Get a quick overview of an API endpoint by its ID, including method, path, summary, and deprecation status.

Instructions

endpoint_by_id

Returns a quick summary of a single endpoint: method, path, summary, and deprecation status.

Use inspect instead when you need the full OpenAPI operation object with parameters, request body, and response schemas.

When to use

Use this tool when:

  • You already have an endpoint ID and want a quick overview

  • The user asks "what is this endpoint?" at a high level

  • You need the method, path, or summary to present to the user

Do NOT use this tool when you need technical details (schemas, parameters, request body) — use inspect instead.

Parameters

  • id (required): The 32-character MD5 hash ID of the endpoint

Returns

The endpoint's method (GET/POST/etc.), path, summary, and whether it's deprecated.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesrequired,Unique identifier for the endpoint
Behavior4/5

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

Annotations already declare readOnly and idempotent hints. The description adds that it returns a summary and lists the exact fields, clarifying the limited scope. No contradictions with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-organized with headings and bullet points, making it easy to scan. While somewhat long, each section adds practical value and there is no redundant fluff.

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

Completeness5/5

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

For a single-parameter tool with no output schema, the description fully covers the return value, usage context, and parameter format. It is complete for an agent to decide when to invoke and what to expect.

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 covers the parameter but only with 'Unique identifier'. The description adds a valuable detail: the ID is a 32-character MD5 hash, which helps the agent understand what value to provide. This goes beyond the schema.

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?

The description clearly states it returns a quick summary of a single endpoint with specific fields (method, path, summary, deprecation status). It distinguishes itself from the `inspect` sibling tool by contrasting the summary level vs. full OpenAPI operation object.

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?

Explicit 'When to use' and 'Do NOT use' sections provide clear guidance, including using `inspect` for technical details. This gives the agent concrete criteria for selection versus alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mmadfox/swag2mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server