Deploy API to Dev
deployment_deployDeploy the current draft to the Dev environment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiId | Yes | ||
| changelog | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | ||
| skipped | No | ||
| versionNumber | No |
deployment_deployDeploy the current draft to the Dev environment.
| Name | Required | Description | Default |
|---|---|---|---|
| apiId | Yes | ||
| changelog | No |
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | ||
| skipped | No | ||
| versionNumber | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false and destructiveHint=true, so the write/destructive nature is covered. The description adds the source (current draft) and target (Dev) but says nothing about what the deploy overwrites, whether a prior dev deployment is replaced, or any prerequisite validation - the details an agent needs for a destructive operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with zero filler; the verb, source and target all appear immediately.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be explained, but for a destructive two-parameter tool the definition omits parameter meaning, prerequisites, and the consequences of overwriting the Dev deployment. It is too thin to safely invoke.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description carries the full burden for apiId and changelog. It alludes to the draft implicitly but never explains apiId (the API to deploy) or what changelog is for, leaving both parameters undocumented anywhere.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Deploy), source (the current draft) and target (Dev environment), which lets an agent separate it from deployment_promote and deployment_rollback. It never names those siblings explicitly, so the differentiation is inferential rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use, when-not-to-use, or alternative guidance is given. With siblings like draft_validate, deployment_promote and deployment_rollback present, an agent gets no signal about whether validation must precede deployment or when to promote instead of deploy.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.