Skip to main content
Glama

docs

Read-only

Search the Ployz docs, or read a page by path. Pages: production-checklist, self-hosting, account/{account,agent-sidebar,connect-an-agent,notifications,organizations,permissions,try-without-an-account}, builds/{build-resources-and-cache,overview,railpack-and-dockerfiles,where-builds-run}, cli/overview, deploy/{deployments,docker-image,github,history-and-rollback,zero-downtime}, environments/{environments,preview-environments}, getting-started/{introduction,quick-start,the-basics}, observe/{analytics,logs,metrics,uptime}, servers/{add-a-server,add-many-servers,manage-servers,recovery-code}, services/{configs,databases,domains,mirror-a-volume,move-a-volume,private-networking,restore-a-volume,scaling,services,settings,variables,volumes}, troubleshooting/{app-not-reachable,builds,deployments,servers,trace,volumes}. This call asks no human.

Input Schema

NameRequiredDescriptionDefault
queryYesA question, or a page path ending in .md.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is known. The description adds that the call 'asks no human', which is useful behavioral context, but it does not describe search result format, pagination, or what a page read returns. With annotations covering safety, this is adequate but not rich.

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

Conciseness4/5

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

The action is front-loaded in the first sentence, and the long page list is justified by providing concrete retrievable paths. The only slightly odd sentence is 'This call asks no human', but it is short and does not distract. Overall it is appropriately sized for a documentation retrieval tool with enumerated pages.

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

Completeness4/5

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

For a read-only documentation tool with one parameter and no output schema, the description gives enough context to call it correctly: search mode, read-by-path mode, and the full set of known page paths. It does not explain return shape or search ranking, but no output schema exists and those details are less critical for invocation.

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 parameter description already says 'A question, or a page path ending in .md.' The tool description adds value by listing the valid page paths, effectively serving as an enum of supported documents, which goes beyond the schema's generic string field.

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 uses specific verbs ('Search' and 'read') and a clear resource ('the Ployz docs'), and explicitly distinguishes the two modes by query type. It also enumerates page paths, so an agent can immediately tell whether it can retrieve a known page or search generically.

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

Usage Guidelines4/5

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

It states the two usage modes: pass a question to search, or pass a page path ending in .md to read a specific page. The extensive page list further clarifies when the read-by-path mode is applicable. No explicit exclusion or sibling-based routing is needed because no equivalent sibling exists.

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.