get_audit_statusTrack BotArmor audit progress by checking levels completed out of total and retrieving the final grade when complete.
Status and progress of a BotArmor audit (levels done out of total), and the grade once completed.
| Name | Required | Description | Default |
|---|---|---|---|
| audit_id | Yes | Audit id, e.g. BA-7NRZ26D4 |
Changes observed during successful MCP inspections.
v0.1.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already covers safety. The description adds useful behavioral context about what the response contains: levels completed out of total and the grade once completed, which helps the agent understand state progression.
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 compact sentence with zero wasted words. The purpose and return progression are front-loaded and easy to parse.
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?
Given no output schema, the description still explains the shape of the return value (progress and final grade). It does not mention error conditions, polling behavior, or how long audits take, which would be useful but are not essential.
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 audit_id parameter is fully documented with a pattern and example. The description adds no additional parameter meaning beyond the schema, so the baseline of 3 applies.
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 resource (a BotArmor audit) and what it returns (status, progress, and final grade). It implicitly contrasts with get_audit_report and list_audits by focusing on progress rather than the report itself or a list.
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 implied: polling an audit after starting it or checking progress until completion. It does not explicitly say when to use this instead of get_audit_report or list_audits, nor does it mention prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.