get_brand
Get details for a specific brand by ID
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The brand ID | |
| workspaceId | Yes | Workspace ID — get the list from the list_workspaces tool |
Get details for a specific brand by ID
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The brand ID | |
| workspaceId | Yes | Workspace ID — get the list from the list_workspaces tool |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds nothing beyond that — no note on what fields are returned, whether a missing ID errors or returns empty, or any permission requirements.
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?
A single front-loaded sentence with zero waste. It is arguably under-specified rather than over-long, but there is no filler to trim.
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 read tool with full schema coverage and explicit annotations, the description is minimally viable. It omits the returned field set and any error behavior, which matters somewhat since no output schema exists.
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 100%, so both parameters are already documented, including the useful hint that workspaceId comes from list_workspaces. The description's 'by ID' merely restates the schema and adds no new syntax or format detail; baseline 3 applies.
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?
States a specific verb ('Get') and resource ('brand') scoped to a single record identified by ID, which distinguishes it from the list_brands sibling. It does not explicitly name the alternative tools, but the single-record scope is clear from the wording.
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 statement of when to use this over list_brands or get_brand_rankings, and no prerequisites such as needing an ID obtained from list_brands. The only routing hint is buried in the schema's workspaceId description, not in the tool description itself.
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.