Skip to main content
Glama
rawveg

OpenAPI Directory MCP Server

get_endpoint_examples

Fetch request and response examples for a specific API endpoint by specifying the API ID, HTTP method, and endpoint path.

Instructions

Get request and response examples for a specific API endpoint

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_idYesAPI identifier (e.g., "googleapis.com:admin", "github.com")
methodYesHTTP method (GET, POST, PUT, PATCH, DELETE, etc.)
pathYesAPI endpoint path (e.g., "/users/{id}", "/posts")
Behavior2/5

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

No annotations are provided, so the description carries full burden. It does not disclose whether examples are pre-generated or fetched live, any authentication requirements, or potential rate limits. The simple 'get' implies read-only, but no further behavioral context is given.

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?

Single sentence with no extraneous words. Efficiently conveys the core purpose. Could be slightly more descriptive (e.g., 'sample' instead of 'examples'), but still concise.

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 simple tool with 3 well-described parameters and no output schema, the description is adequate but minimal. It does not specify the output format (e.g., array of examples) or any ordering, which would be helpful for a complete understanding.

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%, with clear descriptions for each parameter (api_id, method, path). The tool description adds no additional meaning beyond the schema, so baseline score of 3 is appropriate.

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 clearly states it retrieves request and response examples for a specific API endpoint. It is a specific verb-noun pair that distinguishes it from sibling tools like get_endpoint_schema or get_endpoint_details.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives. For example, it does not contrast with get_endpoint_schema (which returns the full schema) or get_endpoint_details (which may return other metadata). The agent is left to infer usage from the tool name.

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/rawveg/openapi-directory-mcp'

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