Skip to main content
Glama

health_check

Verify system health and connectivity to ensure the Vibe platform is operational. Diagnose connectivity issues with a single check.

Instructions

Check the health and connectivity of the Vibe system

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • Core handler implementation: _execute_health_check method in VibeMCPTools class. Makes an API call to get_project_list as a health probe and returns status, message, and api_accessible fields. Sets 'healthy' on success, 'unhealthy' on exception.
    async def _execute_health_check(
        self,
        tool_input: dict[str, Any],
        log: structlog.stdlib.BoundLogger,
    ) -> list[TextContent]:
        """Execute health_check tool."""
        try:
            # Try to fetch projects as a health check
            response = await self.vibe_client.get_project_list(environment="Development")
            result = {
                "status": "healthy",
                "message": "Vibe API is responding",
                "api_accessible": response.success,
            }
        except Exception as e:
            log.warning("Health check failed", error=str(e))
            result = {
                "status": "unhealthy",
                "message": f"Vibe API health check failed: {str(e)}",
                "api_accessible": False,
            }
    
        log.info("Health check completed", result=result)
        return [TextContent(type="text", text=json.dumps(result, indent=2))]
  • Tool schema definition: _get_health_check_tool method defines the MCP Tool with name 'health_check', description, and empty input schema (no parameters required).
    def _get_health_check_tool(self) -> Tool:
        """Define Health Check tool."""
        return Tool(
            name="health_check",
            description="Check if Vibe API server is healthy and responsive",
            inputSchema={
                "type": "object",
                "properties": {},
                "required": [],
            },
        )
  • FastMCP registration: @mcp.tool decorator registers 'health_check' with the FastMCP server. The async wrapper calls _execute_health_check and returns the text result.
    @mcp.tool(
        name="health_check",
        description="Check the health and connectivity of the Vibe system",
    )
    async def health_check() -> str:
        try:
            result = await _tools()._execute_health_check(
                {},
                logger.bind(tool="health_check"),
            )
            return result[0].text
        except Exception as e:
            log = logger.bind(tool="health_check")
            log.error("Tool execution failed", error=str(e))
            raise MCPToolExecutionError(f"Tool execution failed: {str(e)}") from e
  • Tool listing: get_all_tools() includes _get_health_check_tool() in the returned list of all available tools.
    return [
        self._get_project_list_tool(),
        self._create_repo_tool(),
        self._create_bucket_tool(),
        self._get_activity_tool(),
        self._get_code_tool(),
        self._get_health_check_tool(),
    ]
  • Dispatch routing: execute_tool() routes the 'health_check' tool name to _execute_health_check.
    elif tool_name == "health_check":
        return await self._execute_health_check(tool_input, log)
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It only says 'check health and connectivity' without disclosing whether it is read-only, if it requires authentication, or any side effects. Minimal behavioral context.

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?

A single, concise sentence that conveys the purpose without any extraneous words. Front-loaded and to the point.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no parameters and an output schema exists, the description is reasonably complete. It could mention that this is a lightweight readiness check or typical use case, but it is sufficient for a health check tool.

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?

There are no parameters, so schema coverage is 100%. The description adds no parameter-specific meaning, but with 0 parameters the baseline is 4. No further information needed.

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?

The description clearly states the verb 'Check' and the resource 'health and connectivity of the Vibe system', and distinguishes from sibling tools which deal with specific entities like buckets, repos, or activities.

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

Usage Guidelines3/5

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

The description implies usage for checking system health, but does not explicitly state when to use it versus alternatives or provide any exclusions. For a simple health check, this is adequate but lacks 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/Coding-Professional/McpServer_Vibe'

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