Skip to main content
Glama

PolyAI Docs

Search documentation

search_poly_ai_platform
Read-onlyIdempotent

Search across the PolyAI Platform knowledge base to find relevant information, code examples, API references, and guides. Use this tool when you need to answer questions about PolyAI Platform, find specific documentation, understand how features work, or locate implementation details. The search returns contextual content with titles and direct links to the documentation pages. If you need the full content of a specific page, use the query_docs_filesystem tool to head or cat the page path (append .mdx to the path returned from search — e.g. a result at /some/page is read with head -200 /some/page.mdx).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search_poly_ai_platform"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYesSearch query

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare this read-only, idempotent, and non-destructive, so the safety profile is covered. The description adds genuinely useful behavior beyond them: results are contextual snippets with titles and direct links, and page paths map to `.mdx` files readable via the sibling tool. It stops short of stating result counts, ranking, or pagination/limits, which keeps it off 5.

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?

Purpose and usage are front-loaded, and the follow-up workflow with the sibling tool comes last where it belongs. The worked example (`/some/page` → `head -200 /some/page.mdx`) is longer than necessary but is concretely actionable rather than filler.

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?

With no output schema, the description carries the burden of explaining returns, and it does so (contextual content plus titles and direct links). Combined with the sibling hand-off for full content, an agent can chain calls correctly; only result volume and pagination behavior are left unstated.

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

Parameters3/5

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

There is a single required parameter and schema description coverage is 100%, so the schema already defines it; baseline 3 applies. The description never clarifies whether `query` should be natural language, keywords, or a phrase, so it adds no real meaning over 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 and resource ('search across the PolyAI Platform knowledge base') and enumerates the content types it indexes (code examples, API references, guides). It also makes clear what the tool is not: it returns pointers with links, not full page bodies, which separates it from query_docs_filesystem_poly_ai_platform.

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?

It gives explicit when-to-use triggers ('answer questions about PolyAI Platform', 'understand how features work', 'locate implementation details') and names the alternative with the exact condition that selects it — use query_docs_filesystem when you need the full content of a specific page. That is a complete routing rule, not an implied one.

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