neuron_sync_knowledgeRefresh embeddings and reindex content by synchronizing a knowledge base. Provide the unique ID to update its state.
Trigger a synchronization operation to refresh embeddings, reindex content, or update the knowledge base state.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique identifier of the knowledge base to synchronize |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate non-readOnly (write operation), idempotent, and non-destructive. Description adds that it triggers a sync but does not elaborate on side effects, asynchronous behavior, or what gets refreshed. Adequate but not enhanced beyond annotations.
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 front-loading the action and purpose with no wasted words. Efficient and clear.
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?
Tool is simple (1 param, no output schema) but description does not explain return value or behavior (e.g., whether it's synchronous, returns success status). Some information missing for full contextual understanding.
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?
Only one parameter 'id' with description matching schema. Schema coverage is 100%, so description adds no extra semantics beyond the schema. Baseline score of 3 is appropriate.
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 triggers a synchronization operation for a knowledge base, mentioning specific actions like refreshing embeddings, reindexing, and updating state. This distinguishes it from sibling tools like create or update knowledge base.
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 guidance on when to use this tool versus alternatives, such as when a knowledge base needs syncing after updates. No prerequisites or exclusions mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.