Skip to main content
Glama
Sign In
Apitomy Data Models MCP

Apitomy Data Models MCP

Official
by Apitomy
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

document_list_paths

Lists all paths or channels in an API document along with their supported operations, enabling quick navigation and review of API endpoints.

Instructions

List all paths (OpenAPI) or channels (AsyncAPI) with their operations

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

Input Schema

NameRequiredDescriptionDefault
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; description does not disclose read-only nature, authentication needs, or potential side effects. For a list tool, basic behavioral context is missing.

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, very concise. Includes essential information. Minor room for improvement by adding context like return type.

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

Completeness4/5

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

Adequate for a simple list operation. No output schema but return structure is implicit. Could mention that it returns paths/channels with operations, but completeness is sufficient.

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?

Only one parameter 'session' with schema coverage 100%. Description adds no additional meaning beyond schema. 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?

Description clearly states verb 'List', resource 'paths or channels', and specifies API types (OpenAPI/AsyncAPI). Differentiates from sibling tools like 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?

Provides clear context for what it lists but no explicit when-to-use, when-not, or alternatives. Among many siblings, usage guidance would help but is not misleading.

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