Get service status
api2pdf_get_statusReturn the current Api2Pdf service / health status. Api2Pdf API: GET /status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
api2pdf_get_statusReturn the current Api2Pdf service / health status. Api2Pdf API: GET /status.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Input schema / $schemaPrevious value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds the underlying REST mapping (GET /status), which is useful for an agent reasoning about the API, but it says nothing about auth requirements, rate limits, or failure behavior (e.g. what an unhealthy status 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?
Two short sentences with the purpose front-loaded and the API endpoint as a compact trailing detail. Nothing is padded and nothing important is buried.
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-arg, read-only status endpoint with annotations covering safety, the description is nearly sufficient. With no output schema present, it could go one step further and hint at the shape of the health payload, but that is a minor omission rather than a blocking gap.
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?
The tool takes zero parameters, so there is no parameter semantics to compensate for; the empty schema is self-explanatory and the description correctly implies no arguments are needed. Baseline 4 for a 0-param tool.
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 ('Return') and resource ('Api2Pdf service / health status'), which is immediately distinguishable from the document-processing siblings. It stops short of explicitly differentiating itself from the other meta-tool in the set, api2pdf_get_balance, but the resource is clear enough that an agent can tell them apart.
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 description says what is returned but never states when to call it — e.g. before issuing PDF operations or when diagnosing failures — nor does it mention any alternative or prerequisite. Usage is only inferable from the endpoint's nature, not from the text.
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.