publish
Publish a product (set status=active) so it shows on the storefront. Requires Bearer token. WRITE.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| product_id | Yes | Product id to publish. |
Publish a product (set status=active) so it shows on the storefront. Requires Bearer token. WRITE.
| Name | Required | Description | Default |
|---|---|---|---|
| product_id | Yes | Product id to publish. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate readOnlyHint=false, idempotentHint=true, destructiveHint=false. The description adds context by specifying 'set status=active' and 'Requires Bearer token', which goes beyond annotations. No contradictions.
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 very concise at 18 words, front-loaded with the main action, and every word adds value. No wasted text.
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?
Given the simplicity of the tool (one parameter, no output schema, no nested objects), the description covers all necessary aspects: action, auth, effect. Complete for its purpose.
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% for the single parameter 'product_id', which already has a description. The description adds no new information about the parameter semantics.
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 verb 'Publish', the resource 'product', and the effect 'set status=active' and 'shows on the storefront'. It distinguishes from siblings like 'create_product' and 'delete_product' by specifying the action of making a product active.
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 the authentication requirement ('Requires Bearer token') and the type of operation ('WRITE'), but does not explicitly state when to use this tool versus alternatives like 'set_price' or 'create_product'. No when-not-to-use guidance is provided.
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.