index_knowledge

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

No annotations, but description discloses scanning of Markdown files, extraction of YAML frontmatter and wiki-links, and building of FTS5 index. Provides behavioral detail beyond a simple 'index' statement.

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?

Two sentences, front-loaded with purpose, no redundant words. Every sentence adds value.

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?

Covers core functionality and prerequisite. No output schema, but description implies index is built for later search. Could mention duration or scope, but sufficient.

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?

No parameters; schema coverage 100%. Baseline 4 applies. Description adds value by explaining the type of content indexed.

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?

Clearly states the verb 'Index' and the resource 'Obsidian vault or knowledge base' with specific purpose 'for full-text search'. Distinct from sibling retrieval tools.

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?

Mentions requirement of knowledge adapter (ObsidianAdapter) as prerequisite. Does not explicitly specify when to use or alternatives, but context is clear.

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