Skip to main content
Glama

health

Check Splunk connection status and list available applications to verify system accessibility and configuration.

Instructions

Get basic Splunk connection information and list available apps (same as health_check but for endpoint consistency)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function for the "health" MCP tool, decorated with @mcp.tool() for registration. It simply delegates to the health_check() function.
    @mcp.tool()
    async def health() -> Dict[str, Any]:
        """Get basic Splunk connection information and list available apps (same as health_check but for endpoint consistency)"""
        return await health_check()
  • The core implementation logic for performing the Splunk health check, which connects to Splunk, lists available apps, and returns connection status and app information. This is called by the 'health' tool handler.
    @mcp.tool()
    async def health_check() -> Dict[str, Any]:
        """Get basic Splunk connection information and list available apps"""
        try:
            service = get_splunk_connection()
            logger.info("🏥 Performing health check...")
            
            # List available apps
            apps = []
            for app in service.apps:
                try:
                    app_info = {
                        "name": app['name'],
                        "label": app['label'],
                        "version": app['version']
                    }
                    apps.append(app_info)
                except Exception as e:
                    logger.warning(f"⚠️ Error getting info for app {app['name']}: {str(e)}")
                    continue
            
            response = {
                "status": "healthy",
                "connection": {
                    "host": SPLUNK_HOST,
                    "port": SPLUNK_PORT,
                    "scheme": SPLUNK_SCHEME,
                    "username": os.environ.get("SPLUNK_USERNAME", "admin"),
                    "ssl_verify": VERIFY_SSL
                },
                "apps_count": len(apps),
                "apps": apps
            }
            
            logger.info(f"✅ Health check successful. Found {len(apps)} apps")
            return response
            
        except Exception as e:
            logger.error(f"❌ Health check failed: {str(e)}")
            raise
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 states what the tool does (get connection info and list apps) but lacks details on permissions required, rate limits, error conditions, or response format. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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 perfectly concise and front-loaded: the first clause states the core purpose, and the second provides important sibling context. Every sentence earns its place with zero wasted words or redundancy.

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, no output schema), the description is reasonably complete for a basic health/status tool. However, without annotations or output schema, it should ideally mention what specific information is returned or any authentication requirements. The sibling comparison adds useful context.

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 already fully documents the parameter situation. The description appropriately doesn't discuss parameters since none exist, which is correct. Baseline for 0 parameters is 4.

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: 'Get basic Splunk connection information and list available apps'. It specifies both the verb ('Get') and the resources ('connection information', 'available apps'), making the function unambiguous. However, it doesn't explicitly differentiate from its sibling 'health_check' beyond noting they're functionally equivalent for endpoint consistency.

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

Usage Guidelines4/5

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

The description provides clear context by stating this tool is 'same as health_check but for endpoint consistency', which implicitly guides usage toward this tool when endpoint consistency is needed. It doesn't explicitly state when NOT to use it or name alternatives beyond the mentioned sibling, but the comparison offers practical guidance.

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/livehybrid/splunk-mcp'

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