Retrieve SmartDoc field content as plain text and raw value to extract formatted data from SmartSuite records for analysis.
Retrieve the content of a SmartDoc field as plain text and raw value.
| Name | Required | Description | Default |
|---|---|---|---|
| recordId | Yes | The record ID | |
| fieldSlug | Yes | The SmartDoc field slug | |
| applicationId | Yes | The application ID |
Changes observed during successful MCP inspections.
v0.9.8Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare 'readOnlyHint: true', so the description adds only the output format ('plain text and raw value'). No additional behavioral traits are disclosed beyond what annotations provide.
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 a single, focused sentence with no wasted words. It is front-loaded with the main purpose and immediately states the output type.
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 simple read operation on a SmartDoc field, the description together with the schema covers all necessary information: what it does, what it returns, and the required input parameters. No output schema is needed for such a straightforward tool.
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% with each parameter having a description. The tool description does not add any new meaning beyond the schema's parameter descriptions, so it meets the baseline 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?
The description uses a specific verb 'Retrieve' and specifies the resource 'SmartDoc field' and the output format 'plain text and raw value'. It clearly distinguishes from sibling write tools like 'smartsuite_append_smartdoc_content'.
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 implies when to use the tool (to retrieve SmartDoc content) but does not explicitly state when not to use it or mention alternatives. However, the context is clear and no exclusions are needed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.