Skip to main content
Glama

Search documentation available to my account

search_account_docs
Read-onlyIdempotent

Read your authorized documentation table of contents and cited sections. Private staff guides require current staff permissions. Requires separate docs:read consent.

Input Schema

NameRequiredDescriptionDefault
limitNo
queryNoSearch words; omit for the table of contents.
documentIdNoDocument id from the table of contents.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world. The description adds real value beyond them: authorization scope ('authorized documentation'), staff-permission requirements for private guides, and a separate docs:read consent requirement — important preconditions an agent would otherwise miss.

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?

Three short, front-loaded sentences with no filler: purpose first, then permission constraints. Slightly telegraphic phrasing ('authorized documentation table of contents') but every sentence carries information.

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

Completeness3/5

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

The auth/permission picture is well covered, but with no output schema the description says nothing about what a result looks like, how sections are cited, or how limit interacts with the table of contents. Adequate for a read-only, no-required-param tool but with clear gaps.

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 coverage is 67%, with query and documentId self-documented and only limit undescribed. The description echoes the table-of-contents behavior already stated in the query schema and adds no syntax, format, or limit/pagination semantics, so it neither compensates nor detracts.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Read') and resource ('authorized documentation table of contents and cited sections'), and the account-scoping is clear. It doesn't name or distinguish itself from siblings like search_docs or get_help_resource, leaving some ambiguity about which doc-search tool to pick.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: 'Private staff guides require current staff permissions' hints at a permission-gated use case, and the schema's 'omit for the table of contents' clarifies the query path. But there is no explicit when-to-use-this-vs-search_docs guidance or stated exclusions.

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