Skip to main content
Glama
Sign In
Apitomy Data Models MCP

Apitomy Data Models MCP

Official
by Apitomy
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

document_get_operation

Retrieve full details of an API operation by providing its path and HTTP method.

Instructions

Get full details of a specific operation by path and HTTP method

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>"
    },
    "name": "document_get_operation"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe API path (e.g. /pets/{petId})
methodNoHTTP method (get, post, put, etc.); if omitted, returns all operations on the path
sessionYesSession name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

A3.5/5.0
Behavior2/5

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

No annotations provided, so the description carries the full burden. It mentions getting 'full details' but does not disclose what those details include, whether the tool has side effects, or any authorization requirements.

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?

Single sentence, no fluff, directly states the tool's function. Highly efficient.

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?

The description covers the basic purpose and parameter behavior (method optionality noted in schema), but lacks details about the return value format and does not compensate for the missing output schema.

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 coverage is 100% with clear descriptions for each parameter. The tool description adds no additional meaning beyond the schema, so a 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 (Get) and resource (full details of a specific operation) and distinguishes it from sibling tools like document_add_operation and document_list_operations.

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 implies usage for retrieving a single operation by path and HTTP method, but provides no explicit guidance on when to use it versus alternatives like document_list_operations or document_get_node.

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