Add note
add_noteAdd or update a note on an article.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| content | Yes | Note content (text or HTML). | |
| article_id | Yes | The article ID. |
add_noteAdd or update a note on an article.
| Name | Required | Description | Default |
|---|---|---|---|
| content | Yes | Note content (text or HTML). | |
| article_id | Yes | The article ID. |
Changes observed during successful MCP inspections.
No schema history has been recorded yet.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false. The description's 'add or update' wording corroborates the idempotent upsert profile, but it adds nothing about whether an existing note is overwritten, whether auth is required, or how the operation behaves on conflict.
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 filler; the core action and its target are stated immediately.
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 two-parameter tool with full schema coverage and no output schema, the description is close to sufficient. The only missing context is what 'update' means for a pre-existing note and how it relates to get_notes/delete_note.
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 article_id and content are already documented, including that content accepts text or HTML. The description adds no parameter-level meaning beyond what the schema provides, so the 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+resource ('add or update a note') and scopes it to an article, which an agent can act on directly. It does not explicitly differentiate itself from siblings like get_notes or delete_note, though the 'add or update' upsert framing implies the boundary.
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 when-to-use guidance, no prerequisites, and no mention of alternatives such as delete_note. The only hint is the implicit upsert ('add or update'), leaving the agent to infer when this beats any sibling tool.
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.