AffixIO API health
affix_healthCheck that the AffixIO verification API is up and get its version.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Optional query parameters. |
affix_healthCheck that the AffixIO verification API is up and get its version.
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Optional query parameters. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description adds that it returns uptime state and version, but says nothing about timeouts, retries, or what a failure looks like.
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 sentence, front-loaded with the check action, no waste.
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?
For a no-required-param health probe with rich annotations and no output schema, the description is minimally adequate but does not explain the shape or meaning of a healthy/unhealthy result, which is the main thing an agent needs.
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 coverage is 100% and the single 'query' bag is documented in-schema; the description adds no parameter detail. 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+resource ('Check that the AffixIO verification API is up') plus an additional return detail (version). Clearly distinguishable from verification siblings like affix_verify.
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?
The name and description imply a health-check liveness probe, but there is no explicit guidance on when to call it versus alternatives (e.g., affix_api_read, affix_trial_quota) or when not to use it.
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.