smartsuite_append_smartdoc_content

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

The description explicitly states that the tool does not replace existing content, which adds behavioral information beyond the readOnlyHint annotation (false). However, it does not disclose potential side effects, error conditions, or rate limits, leaving gaps in transparency.

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 extremely concise with only two sentences, each serving a distinct purpose: stating the action and mode requirement, and clarifying behavioral impact. No extraneous text.

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 simplicity and lack of output schema, the description covers the core purpose and mode requirements. However, it omits details about response format, error scenarios (e.g., invalid field or record), and the confirm parameter's role, leaving some ambiguity for the 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 coverage is 100%, so the input schema already describes all parameters. The tool description does not add any additional parameter-level meaning beyond what is in the schema, leading to a baseline score of 3.

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?

Clearly states the tool appends markdown content to a SmartDoc field, distinguishing it from sibling tools like smartsuite_get_smartdoc_content. The verb 'append' and resource 'SmartDoc field' are specific and unambiguous.

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?

Mentions that readwrite or admin mode is required, providing some usage context. However, it does not specify when to use this tool over alternatives, nor does it provide 'when-not-to-use' guidance. Additional context on when to prefer appending versus overwriting would be helpful.

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