miniapp_inspect_project

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

No annotations are provided, so the description carries the full burden. It states what the tool does (scan and output) but does not disclose whether it modifies anything, required permissions, or performance implications. The description is moderately transparent but lacks details on side effects or assumptions.

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 a single concise sentence that conveys the main purpose. It is front-loaded and efficient, though slightly more structure (e.g., listing inputs and outputs separately) could improve clarity.

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?

For a tool with two optional parameters and no output schema, the description lists the key outputs (pages, tabBar, cloud functions, etc.), providing reasonable completeness. The scope of the tool is clear, though the return format is not described.

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%, so baseline is 3. The description does not add parameter-specific context beyond what the schema already provides. The tool parameters (projectPath, includeReadme) are adequately explained in the 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?

The description clearly states the verb 'scan' and the resource 'local WeChat mini-program project', listing specific outputs (pages, tabBar, cloud functions, business modules, suggestions). It is specific and distinguishes from sibling tools by focusing on inspection.

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 for inspecting a mini-program project but provides no explicit guidance on when to use this tool versus alternatives like miniapp_security_quick_scan or miniapp_project_map. No when-not-to-use or alternative mentions.

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