Retrieve a specific Smart List by its ID to access its saved contacts and filters, enabling targeted follow-up actions without manually rebuilding the list.
Retrieve a Smart List by id. (GET /smartLists/{id})
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| extraQuery | No | Extra raw query parameters not explicitly listed above — e.g. FUB custom field filters like custom.ClosingDate on /people or /deals. Keys and values are sent as-is. |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden. 'Retrieve' and 'GET' imply a read-only operation, but the description does not disclose response shape, error behavior, authentication needs, or any other runtime traits.
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 clear sentence plus a compact endpoint reference. Every element earns its place; there is no redundant or filler content.
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 GET-by-id tool this is minimally adequate, but with no output schema and no annotations the description should provide more context about the returned object and any relevant usage caveats. It also omits guidance about the sibling list_smart_lists 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 50%: extraQuery is described but id is not. The description adds some meaning by showing id as a URL path parameter in /smartLists/{id}, but it does not explain what the id corresponds to beyond the resource name.
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 and resource: 'Retrieve a Smart List by id.' The path parameter {id} makes the purpose unambiguous and distinguishes it from list_smart_lists, which lists smart lists rather than fetching one.
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?
There is no guidance about when to use this tool versus alternatives like list_smart_lists. The description only states the operation; it does not say 'use this when you have a specific id' or mention any exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.