smokeball_get_layout

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

The description mentions routing through /api/tools/invoke under JWT, tenant, and company scope, indicating authentication requirements. However, no annotations exist, and the description does not explicitly state that this is a read-only operation or disclose any side effects.

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 short (3 sentences) and front-loaded with the tool name and operation. However, it could be more informative without losing 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?

The description does not explain what a 'layout' is, how this tool relates to siblings like 'get_layout_contacts', or what the output schema contains. For an agent to use it effectively, more context about the expected arguments and return value is needed.

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?

The only parameter, 'arguments', is described as a JSON string for the connector operation. This adds minimal meaning beyond the schema, which also shows it as a string. The description does not specify expected keys or structure, leaving a significant gap for agents.

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 states it is a 'get_layout' operation for Smokeball, but does not explain what a 'layout' is in this context. It is distinguishable from siblings like 'get_layout_contacts' by name, but lacks explicit clarification.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., smokeball_get_layout_contacts). There is no mention of prerequisites, context, or 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.