Skip to main content
Glama
clarkemn

cortex-cloud-docs-mcp-server

get_index_status

Check how many documents are cached in the Cortex Cloud documentation index to monitor data availability.

Instructions

Check how many documents are currently cached.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function for the 'get_index_status' tool. It is decorated with @mcp.tool() which registers it with the MCP server. Returns JSON with cache statistics: total cached pages, expired pages, search cache entries, and breakdown by site.
    @mcp.tool()
    async def get_index_status() -> str:
        """Check how many documents are currently cached."""
        total_docs = len(indexer.cached_pages)
        sites = {}
        for page in indexer.cached_pages.values():
            site = page.site
            sites[site] = sites.get(site, 0) + 1
        
        # Also show cache statistics
        expired_count = sum(1 for page in indexer.cached_pages.values() if page.is_expired)
        
        return json.dumps({
            'total_cached_pages': total_docs,
            'expired_pages': expired_count,
            'search_cache_entries': len(indexer.search_cache),
            'by_site': sites
        }, indent=2)
  • The handler function for the 'get_index_status' tool. It is decorated with @mcp.tool() which registers it with the MCP server. Returns JSON with cache statistics: total cached pages, expired pages, search cache entries, and breakdown by site.
    @mcp.tool()
    async def get_index_status() -> str:
        """Check how many documents are currently cached."""
        total_docs = len(indexer.cached_pages)
        sites = {}
        for page in indexer.cached_pages.values():
            site = page.site
            sites[site] = sites.get(site, 0) + 1
        
        # Also show cache statistics
        expired_count = sum(1 for page in indexer.cached_pages.values() if page.is_expired)
        
        return json.dumps({
            'total_cached_pages': total_docs,
            'expired_pages': expired_count,
            'search_cache_entries': len(indexer.search_cache),
            'by_site': sites
        }, indent=2)
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 mentions 'cached' documents, implying read-only behavior, but fails to detail aspects like authentication needs, rate limits, or what 'cached' specifically entails. This leaves significant gaps in understanding the tool's operational traits.

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 front-loads the core purpose without any wasted words. It is appropriately sized for a simple tool with no parameters, making it easy to parse and understand quickly.

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 the tool's simplicity (0 parameters, no annotations, but with an output schema), the description is minimally adequate. It states what the tool does but lacks details on behavioral context and usage guidelines. The presence of an output schema means return values are documented elsewhere, but the description could better address operational aspects.

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

Parameters4/5

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

The tool has 0 parameters with 100% schema description coverage, so the schema fully documents the lack of inputs. The description adds no parameter information, which is acceptable here, but it doesn't compensate for any gaps since there are none. A baseline of 4 is appropriate as no parameters exist to explain.

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 tool's purpose with a specific verb ('Check') and resource ('documents currently cached'), making it easy to understand what the tool does. However, it doesn't explicitly differentiate from sibling tools like 'search_all_docs' or 'index_cortex_api_docs', which prevents a perfect score.

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 alternatives like 'search_all_docs' or 'index_cortex_docs'. It lacks context about prerequisites, timing, or comparisons to sibling tools, leaving the agent to infer usage scenarios independently.

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