Skip to main content
Glama

nexus_generate_audit_report

Read-onlyIdempotent

Generates the current audit report from Nexus APIs, summarizing repository state for audit and documentation.

Instructions

Generate the current audit report from available Nexus APIs.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds only "current" (implying freshness/no persistence of history) and "from available Nexus APIs" (implying dependence on which APIs are configured), but does not say whether anything is written to disk, what happens when APIs are unavailable, or how long generation takes.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One short sentence with no filler and the action front-loaded. Its brevity works against it slightly, since the single sentence is essentially all the guidance provided.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Return-value documentation is unnecessary because an output schema exists, and there are no parameters to explain. Still, for a zero-arg report generator the description is thin: it does not characterize the report's contents or scope, nor how it relates to the sibling audit tools, which is the main thing an agent needs to choose it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the schema carries no semantics that the description must compensate for; baseline 4 applies. The only descriptive nuance, scoping to "available Nexus APIs", slightly clarifies what the call operates against.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ("Generate ... audit report"), so an agent knows the action and product. However, it does not distinguish this from the closely related sibling nexus_audit_repository_content or other nexus_generate_* tools, leaving the boundary of "audit report" undefined.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to call this versus nexus_audit_repository_content (which presumably produces the underlying audit data) or the other generate_* siblings such as nexus_generate_inventory_json. No prerequisites, sequencing, or exclusions are stated.

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