Get a link that opens an opportunity in Yardstick
yardstick_opportunities_deep_linkCreate a public deep link for an opportunity workflow view.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | No | ||
| opportunity_id | Yes |
yardstick_opportunities_deep_linkCreate a public deep link for an opportunity workflow view.
| Name | Required | Description | Default |
|---|---|---|---|
| request_id | No | ||
| opportunity_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already convey idempotency (idempotentHint: true) and non-destructiveness (destructiveHint: false). The description adds the meaningful trait that the link is 'public', implying anyone with the link can access the opportunity view, which is useful context beyond the annotations. However, it does not disclose expiration, revocability, or whether authentication is required to open the link.
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, tight sentence that front-loads the core action ('Create a public deep link') before specifying the target ('an opportunity workflow view'). Every word contributes meaning, with no filler or redundancy against the title.
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 two-parameter utility, the core purpose is clear, but there is no output schema and the description does not specify the response shape or field names. The unexplained request_id and the lack of detail about what makes the link 'public' leave minor but real gaps for an agent trying to invoke and consume the result correctly.
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%, so the description carries the full burden for parameter meaning. It never mentions 'opportunity_id' or 'request_id' by name; only the word 'opportunity' hints at the role of opportunity_id. The optional request_id is entirely unexplained, leaving an agent to guess its purpose.
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 states a specific verb ('Create') and resource ('a public deep link for an opportunity workflow view'), and the title reinforces that this returns a link to open an opportunity in Yardstick. It is clear this tool is for opportunities rather than tasks, though it does not explicitly contrast with sibling deep-link tools like yardstick_tasks_deep_link or yardstick_source_links_create.
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 guidance is given about when to use this tool versus alternatives, such as when a task deep link or a source link would be more appropriate. The description implies the basic use case (need an opportunity deep link) but provides no context, prerequisites, or exclusions.
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.