smartsuite_match_solutions

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

The description states 'Persists to a project mapping file,' indicating a write operation, but annotations declare readOnlyHint=true. This is a clear contradiction. Beyond that, the description does not disclose potential side effects, authorization requirements beyond the environment variable, or what happens to existing data. The contradiction severely undermines trust.

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 dense but every sentence adds value. It starts with purpose, then usage steps, then parameter roles, and finally side effect. No fluff. The structure is logical and front-loaded.

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 (migration step with two modes), the description covers workflow, parameters, and high-level output categories (exact/ambiguous/unmatched). However, it lacks details on the exact return structure (e.g., schema of proposed matches) and does not specify what the mapping file looks like. Without an output schema, some agents might need more detail, but the description is adequate for most use cases.

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 baseline is 3. The description adds significant meaning beyond the schema: it explains the two-step workflow (propose vs confirm), how overrides resolve ambiguous/unmatched matches, and the role of nameFilter. This contextual information helps an agent understand parameter interplay.

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 the tool's purpose as 'Step 1 of solution migration: match solutions in a lower-environment workspace to those in your primary (production) workspace by exact name.' It distinguishes from sibling tools like smartsuite_list_solutions and smartsuite_match_applications through the specific migration context.

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 explains when to use this tool (as part of a migration workflow) and provides step-by-step guidance: set primary workspace, call without confirm to propose matches, then with confirm and overrides to finalize. It mentions a prerequisite (SMARTSUITE_ENABLE_CROSS_WORKSPACE) and that source workspace must differ from primary. However, it does not explicitly state when not to use or list alternatives, but the context is clear.

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