Skip to main content
Glama
Sign In

pracht docs

by io.github.JoviDeCroock
OverviewDiscussionsAdmin

Search the pracht docs

docs_search
Read-onlyIdempotent

Full-text search over the pracht framework documentation at https://pracht.resynapse.dev. Returns the best-matching page sections, each with its page path, section anchor, URL, and a snippet. Pass a result's page and section to docs_read for the full text.

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": "docs_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results.
queryYesWords to look for, e.g. `remote mcp oauth` or `defineApp agents`.

Output Schema

NameRequiredDescriptionDefault
messageYesWhy there are no results, when there are none; otherwise empty.
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds that results are ranked 'best-matching page sections' and enumerates result fields, but says nothing about auth, rate limits, or search semantics like ranking or stemming.

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 short sentences, front-loaded with purpose, then return shape, then the next-step routing. Every sentence carries distinct information and nothing is repeated.

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 two-parameter read tool with full schema coverage, annotations and an output schema, this is essentially complete: purpose, source, and the docs_read chaining are all present. The enumerated return fields partly duplicate the output schema, which is the only wasted effort.

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?

Schema description coverage is 100%, so `query` (with multi-word examples) and `limit` (1-20, default 8) are already documented in the schema. The description adds no further meaning about query syntax, operators, or how limit interacts with ranking, so baseline 3 applies.

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 and resource ('Full-text search over the pracht framework documentation') and pins the source with its URL. It also distinguishes itself from the sibling docs_read by describing the search-to-read handoff, so an agent can tell the two apart without opening a schema.

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?

Clear guidance on the follow-up path: results carry `page` and `section`, which are the inputs to docs_read. It does not say when to prefer docs_list (e.g., enumerating all pages) or when search is a poor fit, so exclusions are absent.

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

All pracht docs toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources