get_survey_link
Get the shareable link for a published survey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| survey_id | Yes | The ID of the survey. |
Get the shareable link for a published survey.
| Name | Required | Description | Default |
|---|---|---|---|
| survey_id | Yes | The ID of the survey. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided; description doesn't disclose what happens if the survey is not published or doesn't exist, nor does it mention permissions or side effects. For a retrieval tool, more context about error conditions would improve 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?
Single sentence, eight words, front-loaded with verb and object. Every word 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?
No output schema, so description should mention the return format (e.g., URL string or object with link). Also lacks mention of prerequisite (survey must be published). Incomplete for an agent to fully understand the 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 a minimal description for survey_id. The tool description adds no additional parameter semantics beyond the schema's 'The ID of the survey.' Baseline 3 is appropriate.
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 specifies the action ('Get') and the resource ('shareable link for a published survey'), distinguishing it from siblings like create_survey or publish_survey.
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 explicit when-to-use or when-not-to-use guidance. The description implies the survey must be published, but doesn't state it directly or mention alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Tools have distinct purposes, but create_survey and get_survey_link both involve shareable links, causing slight overlap. Otherwise clearly differentiated.
All tools follow a consistent verb_noun pattern using snake_case, e.g., create_survey, get_responses, publish_survey.
Six tools are well-scoped for a survey management server, covering creation, listing, publishing, and data retrieval without being excessive.
Core survey lifecycle is covered (create, publish, list, get responses, report), but missing update and delete operations are minor gaps.