Create Shared Memory bridge

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

Annotations already signal it is a non-read-only, non-destructive create operation. The description adds critical behavioral details: zero-copy IPC semantics, exact shmName matching, raw headerless buffer risks when format.header=false, and platform-dependent fatal errors.

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?

Four dense sentences with no fluff. The key decisions (direction, kind, shmName) are front-loaded, and every sentence adds operational value without repetition.

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 complexity (6 params, nested format object, absent output schema), the description covers the core workflow, wiring step, and a failure mode. It does not state the success return value (e.g., the created operator path), which would be useful, but otherwise it is highly complete.

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 covers 100% of parameters, so the baseline is 3. The description adds extra meaning by tying direction/kind to the IPC scenario, emphasizing the exact-match requirement for shmName, and explaining the format.header=false garble risk, going beyond schema descriptions.

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 identifies the tool as creating a Shared Memory In/Out TOP/CHOP for zero-copy IPC with other apps, naming specific examples (Notch, Unity, Unreal). It distinguishes itself from generic node creation siblings by referencing shared memory and IPC specifically.

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 conveys the target use case (same-host IPC with external apps) and provides a follow-up step (connect_nodes after Out creation), but it does not explicitly contrast with alternative IO tools or state when not to use it.

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