Skip to main content
Glama

Search the Privatrak docs

search_docs
Read-onlyIdempotent

Search Privatrak's own documentation and get the best-matching sections: page, section heading, URL and the start of the section's text. Use it before telling a user how Privatrak works or how to set something up (data-track and data-track-* syntax, track() and custom events, the tracker's options, framework setup, how funnels, sessions and features count, plans and limits, connecting an AI assistant) instead of answering from memory, and quote the URL when pointing the user there. Search in the product's own words: dead clicks and rage clicks are click problems (/docs/click-problems), shown on the click map too. read_docs_page returns a whole page. The docs describe the product, not this project's data.

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_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoLanguage of the docs: en (default) or de.
queryYesWhat to look up, in plain words: 'data-track attribute', 'how funnels count visitors', 'undo a setup'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: it returns excerpts rather than full pages, and it draws a scope boundary ('The docs describe the product, not this project's data') that prevents the agent from misusing it for project data.

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?

Front-loaded with the core action and return value, and every sentence carries information. The long parenthetical topic list is dense but borders on over-stuffing, keeping it just short of a 5.

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?

With no output schema, the description compensates by naming the returned fields, and it covers scope, usage trigger, sibling alternative and query-phrasing guidance. Nothing an agent needs to call this correctly is missing.

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%, so the baseline is 3, but the description goes further by coaching query vocabulary ('dead clicks and rage clicks are click problems (/docs/click-problems)'), which tells the agent how to phrase a query that the literal term might miss. It does not, however, address the lang parameter.

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?

States a specific verb+resource ('Search Privatrak's own documentation') and enumerates the exact return shape (page, section heading, URL, start of section text). It explicitly distinguishes itself from the sibling read_docs_page, which 'returns a whole page', so an agent can choose between them without opening either schema.

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?

Gives an explicit when-to-use trigger ('before telling a user how Privatrak works or how to set something up'), a when-not ('instead of answering from memory'), and a named alternative ('read_docs_page returns a whole page'). It even prescribes the follow-up behavior of quoting the URL.

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