appknox_reports_create

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

With no annotations provided, the description carries the burden of disclosing behavior. It states that the tool creates a report and returns its ID, which is useful. However, it does not disclose whether the operation is asynchronous, requires specific permissions, or has side effects on existing reports. This is minimal but not misleading.

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?

The description is two concise sentences that front-load the primary action and state the return value. Every word adds value with no redundancy or extraneous detail. It is appropriately sized for the tool's simplicity.

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 the tool's simplicity (one required parameter, no output schema), the description adequately covers the purpose and return value. It lacks details on prerequisites or asynchronous behavior, but for a basic create operation, it is sufficiently complete for an agent to invoke correctly.

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 input schema has 100% description coverage for the single parameter 'file_id', with the description 'File ID to create report for (required)'. The tool description adds no additional semantic meaning beyond the schema. Thus, baseline score of 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?

The description clearly states the tool's purpose: 'Create a vulnerability analysis report for a file.' The verb 'create' and the resource 'report' are specific, and the mention of 'returns the report ID' further distinguishes it from sibling tools like appknox_reports_download. This is a distinct, well-defined action.

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 implies usage when a file ID is available and a report is needed, but it does not explicitly state when to use this tool versus alternatives like analyses or vulnerability. There is no mention of prerequisites (e.g., file must be uploaded) or exclusions. The use case is clear from context, but explicit guidance is missing.

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