Update a subscription topic's name, description, or default status to manage email preferences.
Update a subscription topic (name, description, default).
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| apiKey | No | Send16 API key (overrides SEND16_API_KEY env var) | |
| topicId | Yes | Topic ID | |
| isDefault | No | ||
| description | No |
Changes observed during successful MCP inspections.
v0.5.7Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. Description only lists updatable fields but lacks behavioral context such as permissions, error conditions, or side effects of the update operation.
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 that is concise and front-loaded with purpose. No extraneous information.
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 update tool with no output schema, description covers the basics. Could mention that it performs a partial update and that unchanged fields remain, but overall adequate.
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 40% (only apiKey and topicId described). Description adds meaning for three parameters (name, description, default) beyond schema, but could provide more detail on constraints.
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?
Description clearly states the tool updates a subscription topic and lists the updatable fields (name, description, default). It distinguishes from similar tools like create_topic and delete_topic.
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?
Implied usage (when you want to modify a topic) but no explicit guidance on when to use vs alternatives, prerequisites, or when not to use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.