create_submodel_ref

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

No annotations are provided, so the description carries full responsibility for behavioral disclosure. It only states that a reference is created and maps to a POST endpoint; it does not mention side effects, prerequisites (e.g., Shell must exist), idempotency, duplicate handling, or what the response will be.

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 two short sentences that state the purpose and the corresponding REST endpoint. It contains no filler or redundant information and is well-structured for quick comprehension.

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?

The description covers the core action and target resource but is minimal for a create operation with no annotations and no output schema. It does not explain behavior on error conditions, duplicate references, or whether the submodel itself must already exist, which leaves some ambiguity for a fully autonomous agent.

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%, with shell_id and submodel_ref both described in the input schema. The tool description adds no extra parameter meaning beyond the endpoint path, so the baseline score of 3 is appropriate.

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 a specific action ('Creates a submodel reference') and identifies the target resource ('for a specific Shell'). It distinguishes this tool from siblings like create_submodel (which creates the submodel itself) and delete_submodel_ref (which removes a reference).

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 gives clear context that this tool is for adding a submodel reference to a Shell, and the HTTP endpoint mapping reinforces its purpose. It does not explicitly state when not to use it or mention alternatives like create_submodel, but the resource-specific wording makes the intended use unambiguous.

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