Skip to main content
Glama

Black SEO Analyzer

search_docs

Read-onlyIdempotent

Search Black SEO Analyzer's own documentation and return the matching sections with their URLs. Use it for questions about bseoa itself: what a tool, command, flag or setting does, crawl limits and the page budget, licenses and the hosted plan, installing or configuring the CLI, GUI or connector, or what an issue key means (pass issue_key for that issue's reference page with its fix). Pass query for a question, issue_key for one issue, or neither to list the documentation pages. Works whatever the account's hosted status; does not count against the page budget; limited to 30 calls a minute.

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

Input Schema

NameRequiredDescriptionDefault
queryNoThe user's question or a few keywords, for example "does hosted render JavaScript", "max pages", "what does the hosted plan include". Leave it out to list the documentation pages.
issue_keyNoAn issue key exactly as an issue reports it, for example metadata.missing_meta_description: returns that issue's reference page with its fix. Takes precedence over query.
max_resultsNoHow many sections to return for a query: 5 by default, at most 10.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing three operational facts an agent cannot infer: it works regardless of the account's hosted status, it does not consume the page budget, and it is rate limited to 30 calls per minute. It also discloses the side effect of issue_key mode (returns the reference page with its fix).

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?

Front-loaded with the core action, then behavior, then parameter routing, then constraints. The topic enumeration is dense but each clause maps to a distinct retrieval case, so nothing is wasted.

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?

For a read-only, non-destructive search tool with no output schema and full annotation coverage, the description supplies everything needed: what it searches, what it returns, how to select modes, and the rate/limit constraints. No material gap remains for correct 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?

Schema coverage is 100%, so all three parameters are already documented, including the issue_key-over-query precedence and the 5/10 result bounds. The description's parameter statements largely restate the schema ('pass query... or neither to list'), adding little beyond the required baseline.

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 ('Search Black SEO Analyzer's own documentation') and names the returned payload ('matching sections with their URLs'). It also scopes the tool away from its siblings by limiting it to questions about bseoa itself, versus the crawl/issue data 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?

Explicitly lists the question classes it covers (tool/command/flag meaning, crawl limits and page budget, licensing, install/config, issue-key reference) and gives a concrete routing rule: pass query for a question, issue_key for one issue, or neither to list pages. It also states an exclusion condition by tying issue lookups to issue_key rather than free-text search.

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.