Skip to main content
Glama

Search DocuWriter Platform Docs

search-docuwriter-platform-docs
Read-only

Use this when the user asks how the DocuWriter.ai platform works or requests its published product instructions. Read-only: searches DocuWriter Platform Docs and returns relevant page excerpts with source URLs. It does not search the user's Spaces or the separate API Docs, and it cannot change documentation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesA 2-500 character question or topic about using the DocuWriter.ai platform, such as Spaces, Full Tree Documentation, or Autopilot.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safe-read nature is covered. The description adds value by reaffirming 'Read-only' and 'cannot change documentation', and by disclosing the search scope (excludes Spaces and API Docs) and the return format (excerpts with URLs). This goes beyond the annotations without contradicting them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three focused sentences: the first gives the when-to-use trigger, the second states the read-only action and return value, and the third states exclusions. Every sentence earns its place with no filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter, read-only search tool with no output schema, the description covers the essential context: when to use, what it does, what it returns, and what it deliberately excludes. An agent has everything needed to invoke it correctly and interpret the results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the query parameter is already well-described ('A 2-500 character question or topic'). The description enhances this by giving concrete examples of valid topics ('such as Spaces, Full Tree Documentation, or Autopilot'), which helps an agent formulate appropriate queries without opening the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('searches'), a specific resource ('DocuWriter Platform Docs'), and what it returns ('relevant page excerpts with source URLs'). It also explicitly distinguishes itself from siblings by noting it does not search the user's Spaces or the separate API Docs, making it clearly differentiated from search-space-documents and global-search.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description opens with an explicit trigger condition ('Use this when the user asks how the DocuWriter.ai platform works or requests its published product instructions') and provides clear exclusions ('does not search the user's Spaces or the separate API Docs'). This gives an agent both positive and negative guidance for tool selection.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources