Skip to main content
Glama
Sign In
Apitomy Data Models MCP

Apitomy Data Models MCP

Official
by Apitomy
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

document_add_request_body

Add an empty request body to an OpenAPI 3.x operation using session, path, and method.

Instructions

Add an empty request body to an operation (OpenAPI 3.x only)

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": {
      "session": "<session>",
      "path": "<path>",
      "method": "<method>"
    },
    "name": "document_add_request_body"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe API path (e.g. /pets)
methodYesHTTP method (e.g. post, put, patch)
sessionYesSession name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are provided, so the description bears the full responsibility for behavioral disclosure. It only states 'Add an empty request body,' which implies a mutation but does not disclose side effects, prerequisites, or idempotency. This is inadequate for a modification tool.

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 with the core purpose. However, it could be improved by adding more contextual details without becoming verbose, balancing conciseness with completeness.

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 lack of output schema and annotations, the description is too minimal. It does not explain the result of the operation, whether it can be undone, or any constraints like requiring an existing operation. The description is incomplete for a tool performing a meaningful modification.

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?

Input schema coverage is 100%, with each parameter having a basic description. However, the tool's description adds no additional meaning beyond what the schema provides, such as how the parameters are used or any constraints. The baseline score of 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 clearly states the action ('Add'), the object ('empty request body'), and the context ('to an operation, OpenAPI 3.x only'). It effectively distinguishes from sibling tools that add other elements like callbacks, examples, or parameters.

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?

The description gives no explicit guidance on when to use this tool versus alternatives like document_add_request_body_definition or when not to use it. The 'OpenAPI 3.x only' constraint is helpful but insufficient for a complete usage guideline.

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

Deploy Server

Other Tools