Skip to main content
Glama

describe_common_types

Retrieve common response schemas and shared types from OpenAPI components for a specified service, enabling reuse and consistency across API definitions.

Instructions

Get common response schemas and shared types from components

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
serviceNameYesService name (projectId)
Behavior2/5

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

With no annotations, the description carries the full burden. It states only the action 'Get' and the resource, without disclosing response format, error behavior, or possible side effects. The vagueness of 'common' and 'shared' adds ambiguity.

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?

The description is a single sentence that is front-loaded with the action 'Get'. It contains no wasted words and is easy to parse quickly.

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

Completeness2/5

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

Given the tool has a single parameter and no output schema, the description is under-specified. It doesn't explain what 'common' means, what the returned schemas look like, or how this differs from describe_component, leaving significant gaps for the agent.

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?

The schema describes serviceName as 'Service name (projectId)' with 100% coverage. The description adds no further semantic detail beyond the schema, so baseline 3 is appropriate.

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 uses a specific verb+resource pattern: 'Get common response schemas and shared types from components'. This clearly distinguishes the tool from siblings like describe_api and describe_component, which target different resources.

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 is provided about when to use this tool versus alternatives. It doesn't mention exclusions or refer to sibling tools, leaving the agent to infer usage from the resource description alone.

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/yunhwane/swagger-mcp'

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