Skip to main content
Glama
Sign In
Routebase

Routebase

Official
by routebase-dev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

Search Portal Docs

search_portal_docs
Read-only

Search published documentation by keyword to find matching pages. Returns slugs, titles, sections, and snippets so you can quickly identify and open the right page.

Instructions

Full-text search across a PUBLISHED documentation portal. Searches page titles, headings, and body text of the latest published version and returns matching pages (slug, title, section, snippet). Chain get_portal_page with a returned slug to read the full page. Keyword search only (no semantics). Requires project context (call set_context first).

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": {
      "documentationId": "<documentationId>",
      "query": "<query>"
    },
    "name": "search_portal_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return (default 10, max 50)
queryYesThe search query (case-insensitive keyword match)
documentationIdYesThe public Id (Guid) of the documentation

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the description correctly focuses on additional behavioral context: it searches only the latest published version, returns matching pages with specific fields, and requires set_context. This adds meaningful transparency beyond the annotation without contradicting it.

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 compact sentences front-load the core purpose, then add return details, follow-up guidance, and prerequisites. Every sentence earns its place and there is no redundant repetition of schema or annotation information.

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?

Despite having no output schema, the description names the returned fields (slug, title, section, snippet), covers the prerequisite context, and tells the agent how to proceed to full-page retrieval. Combined with full schema coverage for parameters, this is complete for correct tool 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?

Schema description coverage is 100%, so the schema already documents all three parameters. The description reinforces the keyword-match nature but does not add significant new parameter-level meaning beyond what the schema provides.

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 ('search'), a scoped resource ('PUBLISHED documentation portal'), and the search surface (page titles, headings, body text). It clearly distinguishes this tool from get_portal_page by describing search-and-return behavior rather than full-page retrieval.

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 tells the agent when to use this tool and what to do next: chain get_portal_page with a returned slug to read the full page. It also states limitations (keyword search only, no semantics) and the prerequisite of setting project context first.

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

Deploy Server

Other Tools