Search Documents by Title

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

No annotations are provided, so the description must fully disclose behavior. It states the tool searches by title and returns docId, title, and URL, but does not explicitly confirm read-only nature or mention potential side effects. The lack of safety annotation is partially compensated by the implied read operation, but falls short of full transparency.

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, no redundant words, and front-loaded with the key purpose and benefit. Every sentence adds value without waste.

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 lack of an output schema, the description adequately mentions return fields (docId, title, URL). However, it does not mention the additional filtering capabilities (tag, matchMode, sort) or the limit parameter, which are available in the schema. This omission slightly reduces completeness for a search tool with multiple options.

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 100% description coverage, so the baseline is 3. The description adds no additional parameter-level information beyond what the schema provides, such as usage context for query or matchMode. It does not compensate for any gaps.

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 tool performs a fast search for documents by title using workspace metadata, distinguishing it from siblings like list_docs or get_doc. It specifies the action (search), resource (documents), and a differentiating speed advantage.

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 explicitly mentions the tool is much faster than exporting each doc, providing a clear context for when to use it. However, it does not explicitly state when not to use it or name alternative tools, though the speed hint implies a preference over manual export.

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