Skip to main content
Glama

docs_search

Docs — free text or code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Added

TDQS

C2.1/5.0
Behavior1/5

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

No annotations are provided, so the description must disclose behavioral traits itself. It does not mention whether the operation is read-only, how results are returned, whether free-text and code queries behave differently, or any limitations. The phrase 'free text or code' describes input, not tool behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely terse and has no filler, but it is under-specified rather than efficiently structured. 'Docs — free text or code.' reads like a label or stub rather than a deliberate, complete tool description.

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

Completeness1/5

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

For a tool with no annotations and no output schema, the description must explain what is searched, what constitutes a match, and what the caller receives. None of that is present. The one-line description relies almost entirely on the tool name and parameter name for meaning, which is insufficient for reliable selection and invocation.

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?

The schema defines only a generic 'q' string with no description and 0% schema description coverage. 'Free text or code' at least tells the agent that 'q' accepts natural-language or code-snippet input for the search. However, it does not clarify whether 'q' is optional, how queries are interpreted, or what query syntax is expected.

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

Purpose3/5

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

The description names the resource ('Docs') and the query modality ('free text or code'), and the tool name supplies the 'search' verb. This gives a rough sense of what the tool operates on, but it never explicitly states that it searches documentation or what it returns. It is a fragment rather than a clear verb+resource statement.

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

Usage Guidelines2/5

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

There is no guidance on when to use docs_search versus docs_get or the other *_search siblings. The phrase 'free text or code' only weakly implies a query-based use case; no conditions, alternatives, or exclusions are provided. Usage context is at best implied, not stated.

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.

TDQS

C2.4/5.0
Disambiguation4/5

Most tools are cleanly separated by entity prefix and action (_get vs _search), so AWARE/Box/etc are not easily confused. The main ambiguity is among spl_lab_auth, spl_agent_key, and spl_signup, which all relate to account/key creation and could cause misselection.

Naming Consistency3/5

The 24 entity tools follow a consistent <entity>_get/<entity>_search pattern, which is predictable and readable. However, the five spl_* tools mix noun-style names like spl_catalog with verb-style names like spl_discover and spl_signup, creating a noticeable second convention.

Tool Count2/5

At 29 tools, the server exceeds the comfortable 3-15 range and even the heavier 16-25 range. The 12 get/search pairs are systematic, but combined with the five spl_* tools the overall surface feels bloated and harder to scan.

Completeness4/5

For a retrieval-oriented knowledge server, every entity has both point lookup and free-text search, plus lab signup, agent key minting, and discovery/catalog resources. Minor gaps like no key revocation or list-all operations are not critical for the stated purpose.

Resources