Skip to main content
Glama
Apitomy

Apitomy Data Models MCP

Official
by Apitomy

document_add_parameter

Add a parameter to an API path item or operation, with options for name, location, type, required flag, and description.

Instructions

Add a parameter to a path item or operation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesParameter name
pathYesThe API path (e.g. /pets)
typeNoSchema type (string, integer, number, boolean, array). Defaults to string
methodNoHTTP method (omit to add to path item level)
sessionYesSession name
locationYesParameter location: query, path, header, cookie
requiredNoWhether the parameter is required
descriptionNoParameter description
Behavior2/5

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

No annotations are provided, and the description only states the basic action. It does not disclose behavioral traits like whether the tool modifies the document in place, validates parameters, or has side effects. The description carries full burden for transparency but fails to provide it.

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

Conciseness3/5

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

The description is a single sentence that is concise and front-loaded. However, it lacks important details like the optional method parameter and how it affects behavior. Could be more informative without being verbose.

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 8 parameters (4 required) and no output schema, the description is too minimal. It does not explain return values, session integration, or how to choose among the many sibling tools. Incomplete for an AI agent's decision-making.

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%, so the schema already documents all 8 parameters. The description adds no extra meaning beyond what the schema provides. Baseline 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 'Add a parameter to a path item or operation' clearly states the action (add), resource (parameter), and scope (path item or operation). It differentiates from siblings like document_add_parameter_definition, but does not distinguish from other document_add_* tools for different components.

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 on when to use this tool versus alternatives, such as adding a parameter definition or adding other components. No context on prerequisites or appropriate use cases.

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/Apitomy/apitomy-data-models-mcp'

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