maid_snapshot_system

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

Describes output as aggregated manifest using systemArtifacts array instead of expectedArtifacts object, and mentions return type. No annotations exist, so description carries burden; it does not disclose side effects, auth needs, or potential destructive actions, but given nature of tool, likely non-destructive.

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?

Well-organized with headings, bullet points, and sections. The Args section duplicates schema info without adding value, slightly reducing conciseness.

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?

Covers purpose, usage, and high-level output. Lacks parameter details and behavioral nuances. Output schema exists but not described, so completeness is adequate but not thorough.

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 coverage is 0%, so description should compensate. Args are listed with defaults but no additional explanation of formats, constraints, or how they affect behavior. Barely adds meaning beyond schema.

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?

Clearly states it generates a system-wide manifest snapshot. Use cases like documentation, architecture review, and dependency analysis distinguish it from siblings like maid_snapshot (per-file) and maid_list_manifests.

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?

Provides explicit 'When to use' section with three bullet points. Also includes tips for periodic runs and onboarding. Lacks explicit when-not-to-use, but usage context is clear.

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