Skip to main content
Glama
ixlammm

apidog-mcp

by ixlammm

apidog_add_endpoint

Add an API endpoint to an Apidog project by exporting, modifying, validating, and importing its OpenAPI specification.

Instructions

Add an endpoint by export-modify-validate-import.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
methodYes
optionsNo
branchIdNoOptional Apidog branch ID. Falls back to apidog.json.
moduleIdNo
operationYesOpenAPI operation object. A default 200 response is added if responses is omitted.
projectIdNoApidog project ID. Falls back to apidog.json.
oasVersionNo3.1
exportFormatNoJSON
environmentIdsNo
addFoldersToTagsNo
includeApidogExtensionPropertiesNo
Behavior2/5

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

With no annotations, the description carries the full burden of disclosing side effects and safety traits. It reveals a multi-step process (export-modify-validate-import), but does not explain whether existing endpoints are overwritten, if validation failures are handled gracefully, or what happens to unmatched resources. This leaves significant ambiguity for a mutating operation.

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?

The description is a single, front-loaded sentence with no padding. Every word contributes to the basic purpose, though the hyphenated 'export-modify-validate-import' could be clearer. It is concise, but not overly terse to the point of being meaningless.

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's complexity (12 parameters, nested objects, no output schema, no annotations), the description is grossly insufficient. It provides only a high-level workflow and omits crucial context about parameter purposes, preconditions, side effects, or return values. The agent would need to infer too much.

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

Parameters1/5

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

Schema description coverage is only 25% (3 of 12 parameters have any description), and the tool description offers no parameter-level semantics. It does not explain the meaning or role of required parameters (path, method, operation) or the numerous options (schemaOverwriteBehavior, deleteUnmatchedResources, etc.), failing to compensate for the schema's sparse coverage.

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 clearly states the action ('Add an endpoint') and hints at a specific workflow ('export-modify-validate-import'). However, it does not distinguish this tool from siblings like apidog_upsert_endpoint or apidog_import_openapi, leaving the agent to infer the unique value proposition.

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 explicit guidance on when to use this tool versus alternatives is provided. The terse phrase 'by export-modify-validate-import' implies a round-trip process, but there is no mention of prerequisites, exclusions, or selection criteria, leaving the agent without adequate direction.

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/ixlammm/apidog-mcp'

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