Get Deployment Health
nexusai_deploy_healthReturns health check status and recent health logs for a deployment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deploymentId | Yes | Deployment UUID. |
nexusai_deploy_healthReturns health check status and recent health logs for a deployment.
| Name | Required | Description | Default |
|---|---|---|---|
| deploymentId | Yes | Deployment UUID. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered by structured data. The description adds that the payload includes health status and recent health logs, but says nothing about the recency window, volume of logs, pagination, or whether it is a point-in-time snapshot.
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?
One short, front-loaded sentence with no filler. It is efficient, though its brevity comes at the cost of routing information that would earn its place.
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?
No output schema exists, so the description must carry the burden of describing return values, and it only sketches them ('health check status and recent health logs'). Combined with zero sibling differentiation in a crowded deploy_* family, it is minimally adequate but incomplete.
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 100% and the single parameter (deploymentId) is documented in the schema as a Deployment UUID. The description adds no extra meaning about the identifier's format, source, or accepted values, so baseline 3 is appropriate.
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 and resource plus the return contents ('Returns health check status and recent health logs for a deployment'). An agent knows what it does, but nothing distinguishes it from the closely related siblings nexusai_deploy_status and nexusai_deploy_logs, which sound like they overlap heavily.
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?
There is no guidance on when to use this over nexusai_deploy_status or nexusai_deploy_logs, and no stated prerequisites or conditions. The description leaves the agent to guess which of the three deployment-diagnostic tools to pick.
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.