Client Snippets

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

Annotations already provide readOnlyHint=true and idempotentHint=true, making it clear this is a safe read-only operation that can be called repeatedly without side effects. The description adds that it generates snippets and provides placement guidance, but does not disclose the format of the output (e.g., exact code blocks, language specifics) beyond JS + CSS. With annotations covering safety, the description adds moderate value, but it could state that no programmatic changes are made and the output is purely for the UI.

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 sentence that is concise and front-loaded with the core purpose ('Generate copy-pasteable client-side snippets'). It covers key topics (referral tracking, embeddable elements, GrowSurf Window) and adds placement guidance without excessive detail. It could be more structured, but it is efficient and earns its place.

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 tool has 8 parameters with 0% schema description coverage and no parameter documentation in the description, which is a major gap. There is an output schema, which may define the snippet structure, but since it is not shown here, it is unclear. The description is not complete enough for an agent to correctly set all options without further guidance. It needs to either describe parameters or link to resource guides.

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 0%, meaning none of the 8 parameters are described in the schema. The description does not explain any parameters, such as programType, singlePageApp, referralTrigger, or includeGrowSurfWindow. This is a significant gap because an agent must guess the meaning of each boolean and enum from names and defaults, which is error-prone. The description should at least summarize key options to compensate for the lack of schema descriptions.

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 generates client-side snippets for GrowSurf referral tracking, embeddable elements, and the GrowSurf Window, specifying JS + CSS and placement guidance. It distinguishes from sibling tools like growsurf_api_library_snippets and growsurf_embeddable_element_snippet by focusing on client-side copy-pasteable snippets for app UI work. The title 'Client Snippets' is more generic, but the description clarifies the specific output.

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 mentions placement guidance for app UI work, indicating it is intended for front-end integration. It implicitly differentiates from API snippets by naming 'copy-pasteable client-side snippets', but it does not explicitly state when to use this tool versus siblings like growsurf_api_library_snippets or growsurf_mobile_sdk_guide. It lacks explicit when-not-to-use alternatives, but the context is clear enough for an agent to infer the primary use case.

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