Skip to main content
Glama
clarkemn

cortex-cloud-docs-mcp-server

search_all_docs

Search across all Cortex Cloud documentation sites to find specific information using a query.

Instructions

Search across all Cortex Cloud documentation sites.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function that implements the core logic of the 'search_all_docs' tool. It searches all indexed documentation using the indexer and returns the results as a JSON string.
    @mcp.tool()
    async def search_all_docs(query: str) -> str:
        """Search across all Cortex Cloud documentation sites."""
        results = await indexer.search_docs(query)
        return json.dumps(results, indent=2)
  • Identical handler function implementing the 'search_all_docs' tool logic, present in the alternative entrypoint file.
    @mcp.tool()
    async def search_all_docs(query: str) -> str:
        """Search across all Cortex Cloud documentation sites."""
        results = await indexer.search_docs(query)
        return json.dumps(results, indent=2)
  • Global indexer instance initialization, crucial for the tool's search functionality.
    indexer = DocumentationIndexer()
  • Global indexer instance used by the search_all_docs tool.
    indexer = DocumentationIndexer()
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states what the tool does at a high level ('Search across all...'), without explaining what 'all' encompasses, how results are returned, whether there are rate limits, authentication requirements, or any other behavioral characteristics. This leaves significant gaps for a search tool.

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?

The description is a single, efficient sentence that gets straight to the point with zero wasted words. It's appropriately sized for a simple search tool and front-loads the core functionality.

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?

Given that there's an output schema (which handles return values) and only one parameter, the description's brevity is somewhat acceptable. However, for a search tool with sibling alternatives and no annotations, it should provide more context about scope ('all' vs specific documentation sets) and basic behavioral expectations to be truly complete.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate for the lack of parameter documentation. The description mentions 'Search' but provides no additional semantic context about the 'query' parameter - no examples, format expectations, search syntax, or what constitutes a valid query. This leaves the single required parameter poorly understood.

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?

The description clearly states the action ('Search') and target resource ('across all Cortex Cloud documentation sites'), providing a specific verb+resource combination. However, it doesn't distinguish this tool from its sibling tools like 'search_cortex_api_docs' and 'search_cortex_docs', which appear to be more specific search variants.

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?

The description provides no guidance on when to use this tool versus its siblings. It doesn't mention alternatives, exclusions, or specific contexts where this broad search is preferred over the more targeted 'search_cortex_api_docs' or 'search_cortex_docs' tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/clarkemn/cortex-cloud-docs-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server