apidog-mcp

apidog_upsert_endpoint

Create or update an API endpoint operation in Apidog by exporting, modifying, validating, and importing the OpenAPI definition.

Instructions

Create or update an endpoint operation by export-modify-validate-import.

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

Input Schema

Name	Required	Description	Default
`path`	Yes
`method`	Yes
`options`	No
`branchId`	No	Optional Apidog branch ID. Falls back to apidog.json.
`moduleId`	No
`operation`	Yes	OpenAPI operation object. A default 200 response is added if responses is omitted.
`projectId`	No	Apidog project ID. Falls back to apidog.json.
`oasVersion`	No		3.1
`exportFormat`	No		JSON
`environmentIds`	No
`addFoldersToTags`	No
`includeApidogExtensionProperties`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.0.1Jul 31, 2026

TDQS

C2.6/5.0

Behavior2/5

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

With no annotations, the description must fully disclose behavior, but it only hints at the process ('export-modify-validate-import'). It doesn't mention potential side effects such as overwriting existing endpoints, modifying schemas, or the `deleteUnmatchedResources` option that could lead to destructive changes. The mutating and possibly irreversible nature of an upsert is not adequately warned about.

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, compact sentence with no redundant words. It front-loads the primary action and the workflow, making it highly efficient. Every word contributes to conveying the core purpose, so it scores high on conciseness.

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

Completeness1/5

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

This tool is complex (12 params, nested objects, no output schema, no annotations), yet the description provides only a two-word intent and a workflow phrase. It lacks critical context like return values, error behavior, how to obtain projectId/branchId, or what happens during the import phase. The description is wholly inadequate for confident use.

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%, yet the description provides zero parameter explanations. It doesn't clarify required parameters like `path`, `method`, or `operation`, nor the numerous optional parameters and their nested options. This is a severe gap for an agent needing to construct a correct invocation.

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 core action: 'Create or update an endpoint operation', which is specific and identifies the resource. The added workflow 'export-modify-validate-import' helps differentiate it from sibling tools like `apidog_add_endpoint` and `apidog_update_endpoint`, though the description doesn't explicitly contrast those alternatives.

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?

The description gives no explicit when-to-use guidance or alternative tool references. It only implies a workflow (export-modify-validate-import), leaving the agent to infer that this might be for syncing changes. No prerequisites, exclusions, or recommendations are provided, making this a weak area.

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

Deploy Server