veya_api_health

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose that the tool targets the /health endpoint and covers fleet status, which tells the agent this is a read-only diagnostic. It says nothing about authentication, rate limits, or how failures are reported, which for a 0-parameter monitoring endpoint is a modest but real gap.

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 that names the verb, the resource, the host, and the coverage of the check. Nothing is redundant and nothing needs to be trimmed.

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?

With no parameters, no annotations, and no output schema, the definition is nearly complete for a simple diagnostic endpoint — the agent knows what is checked and where. It could still say what the health response includes or whether it requires network reachability, which is why it falls short of 5.

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 are no parameter semantics for the description to explain; the baseline for a no-parameter tool is 4. The parenthetical host reference is harmless context rather than parameter documentation.

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?

The description states a specific verb and resource: 'Check the VEYA API /health status (api.veyanet.tech)', and adds scope detail ('including fleet status'). It does not, however, differentiate itself from related siblings such as veya_public_stats or veya_writes_status, leaving the agent to infer the boundary.

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?

Usage is only implied by the nature of a health check; there is no explicit 'use when' statement, no mention of when to prefer veya_public_stats or veya_writes_status, and no stated prerequisites (e.g. network/auth requirements). An agent can guess the intent but gets no routing guidance.

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