Skip to main content
Glama

docs

The verifAIed documentation, for you and for the user's questions. Free. Call this whenever the user asks how something in verifAIed works or how to do something with it, and whenever you are unsure what a tool, a command, a gap or an error means.

Three ways to call it:

  • no arguments: the table of contents — every page with a one-line summary — and how to use the rest.

  • query: the question, or a few words of it. Returns the sections that match best, each with its own text, so one call is usually enough to answer from. A hit marked truncated was cut short: read its page for the rest. Start here when you do not know which page holds the answer.

  • page: one whole page as Markdown. Pass a name from the contents (the first page is overview); a title or a documentation URL also works.

Pass page or query, not both.

Answer from the returned text rather than from memory, and give the user the page's url so they can read it themselves. A page with no url is one of the notes for agents: tell the user what it says, there is no link to give. When nothing matches, the documentation does not cover it: tell the user that, and do not infer an answer from what is missing. Pages in the group "For agents" are reference written for you and are not on the website: agents/gaps (what every check_done gap means and what closes it), agents/errors (what an error or refusal means and the fix) and agents/formats (exact file and JSON formats, exit codes).

Every answer carries account: the user's plan, and on the free plan a note on what is refused, so you do not suggest a feature this account cannot use. The table of contents has the full list of paid tools.

This is the one tool that works with no account: a connection without credentials can read the documentation, and its account is null. Every other tool needs the user to sign in first.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
queryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

With no annotations present, the description carries the full burden and does so: it discloses that the tool is free and works with no account (returning `account: null`), that responses include an `account` plan field so paid features are not suggested, that a `truncated` hit means the page was cut short, and that pages without a `url` are agent-only notes. It also specifies failure semantics — when nothing matches, the documentation does not cover the topic and no answer should be inferred.

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?

Well front-loaded — the tool's purpose and its 'call this whenever' trigger precede the mode breakdown — and the bulleted structure makes the three call paths scannable. It runs long, and a few clauses (the paid-tools aside, the restatement that it is 'for you and for the user's questions') could be trimmed without losing guidance.

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?

There is no output schema, so the description must describe returns, and it does: matching sections with their own text, `truncated` hits, full Markdown pages, `url` fields, and an `account` field. Auth behavior, the zero-argument path, and unmatched-query handling are all covered, leaving nothing an agent needs before calling.

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

Parameters5/5

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

Schema coverage is 0% and the schema only supplies bare property names ('Page', 'Query'), so the description must compensate and does: it explains that omitting both yields the table of contents, that `query` is 'a few words' of the question and returns best-matching sections with text, and that `page` takes a name from the contents, the first page being `overview`, or alternatively a title or documentation URL. Mutual exclusivity of the two parameters is stated explicitly.

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 the specific resource (the verifAIed documentation) and enumerates the three distinct call modes — contents, `query`, `page` — so an agent knows exactly what the tool returns in each case. It is plainly distinct from every sibling (check_done, setup, list_analyses, etc.), which are operational rather than documentation tools.

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 explicit triggers: 'whenever the user asks how something in verifAIed works' and 'whenever you are unsure what a tool, a command, a gap or an error means.' It also gives routing guidance within the tool ('Start here when you do not know which page holds the answer' for `query`; named pages including `agents/gaps`, `agents/errors`, `agents/formats` for `page`) and an exclusion ('Pass `page` or `query`, not both').

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