sync_knowledge

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions the action 'sync' but doesn't describe what this entails operationally—whether it's a full or incremental sync, how long it takes, if it requires specific permissions, or what happens on failure. The mention of 'vector store' hints at AI infrastructure but lacks practical implementation details.

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 extremely concise with two sentences that directly state the tool's purpose and usage timing. Every word serves a clear function, and it's front-loaded with the core action. There's no wasted verbiage or redundancy.

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 tool's complexity (syncing documents to a vector store for AI search), no annotations, no output schema, and poor parameter documentation, the description is insufficient. It doesn't explain what 'sync' entails operationally, what the vector store is, how to verify success, or error handling. The guidance to run before 'ask_wiki' is helpful but doesn't cover broader contextual needs.

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?

The input schema has 1 parameter with 0% description coverage, and the tool description provides no information about the 'collectionId' parameter. It doesn't explain what a collection is, how to obtain its ID, or whether syncing applies to all collections if omitted. The description fails to compensate for the schema's lack of parameter documentation.

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 'sync' and resource 'documents to vector store', specifying the purpose for 'AI-powered search'. It distinguishes from sibling 'ask_wiki' by indicating this is a prerequisite step, though it doesn't explicitly differentiate from other document/collection management tools like 'batch_create_documents' or 'update_collection'.

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 provides clear context for when to use this tool: 'before using ask_wiki'. This gives explicit timing guidance, but it doesn't mention when NOT to use it or alternatives for similar functionality, such as whether it's needed after document updates or if other tools handle incremental syncing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.