Skip to main content
Glama
Apitomy

Apitomy Data Models MCP

Official
by Apitomy

document_create

Create an empty OpenAPI or AsyncAPI document within a named session, specifying model type, title, and version.

Instructions

Create a new empty OpenAPI or AsyncAPI document in a named session

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoDocument title
sessionYesName for this session
versionNoDocument version
modelTypeYesDocument type to create (openapi2, openapi3, asyncapi2)
Behavior3/5

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

No annotations are provided, so the description must disclose behavior. It states the tool creates an empty document, which is straightforward. However, it does not mention any side effects, such as overwriting an existing session or document, nor does it clarify the return value. The description is simple but lacks depth.

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, concise sentence that efficiently conveys the essential purpose. No unnecessary words or details are included.

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?

The description does not address important contextual aspects such as what happens if the session already exists, whether the document can be overwritten, or what the tool returns (no output schema). Given the absence of annotations, this lack of completeness could hinder an agent's understanding of the tool's full behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% coverage with each parameter described. The overall description adds value by tying parameters together, specifying that the document is 'empty' and created 'in a named session,' which provides context beyond the individual parameter descriptions.

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 identifies the action ('Create'), the resource ('new empty OpenAPI or AsyncAPI document'), and the context ('in a named session'). It effectively distinguishes from sibling tools, which focus on adding, removing, or modifying components of an existing document.

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 that the tool is for initial document creation, but it does not explicitly state when to use it versus alternatives, nor does it provide any usage restrictions or prerequisites. The instruction is adequate but lacks direct guidance.

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