innoslate_initialize

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

The description explicitly states the tool 'writes PROJECT_MAP.md, NOMENCLATURE.md and snapshot.json into the project workspace', i.e. it produces persistent side effects, while the annotations declare readOnlyHint=true (no modification). This is a direct write-vs-readOnly conflict of the same kind the framework asks to flag, so per the rule it scores 1 even though the rest of the behavioral disclosure (reads entities/schema/comments/members, processes guides, returns a summary) is detailed.

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 critical instruction ('Survey the whole project before any write') is front-loaded, and the rest is dense but justified detail. It is slightly long with a compound final sentence, but no sentence is pure filler.

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 complex setup tool with no output schema, it covers what gets read, what gets written, how guides are handled, what it returns, and where to read the full results. The main gaps are the unexplained project_url and the unresolved readOnlyHint conflict, which complete only after the annotation is reconciled.

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 0%, so the description must carry the burden. It does a good job on guides_dir (folder or single file, PDF/DOCX, text saved under guides/, numbering patterns compared), but project_url is never explained, leaving one of two parameters undocumented in both schema and prose.

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 opens with a specific verb+resource ('Survey the whole project') and immediately scopes it ('before any write'), which cleanly distinguishes it from siblings like innoslate_schema, innoslate_find, or innoslate_get that read narrower slices. An agent can tell this is the whole-project survey/provisioning step without opening the schema.

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?

It gives explicit timing ('Run once per project, and again after big changes') and sequencing ('before any write'), and routes the agent forward to innoslate_read_workspace for the full outputs. It stops short of naming which sibling it replaces/excludes (e.g., vs innoslate_get_started or innoslate_status), so it is clear context rather than a full when/alternatives matrix.

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