Skip to main content
Glama

bruno_health_check

Monitor the operational status of the Bruno MCP server and CLI, with options to view performance metrics and cache statistics for system verification.

Instructions

Check the health status of the Bruno MCP server and Bruno CLI

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeMetricsNoInclude performance metrics in output
includeCacheStatsNoInclude cache statistics in output

Implementation Reference

  • The HealthCheckHandler class implements the IToolHandler interface for the 'bruno_health_check' tool. It validates inputs, checks Bruno CLI availability, gathers performance metrics and cache stats if requested, formats the output using HealthCheckFormatter, and returns a text response with health diagnostics.
    export class HealthCheckHandler implements IToolHandler {
      private readonly brunoCLI: IBrunoCLI;
      private readonly configLoader: IConfigLoader;
      private readonly perfManager: IPerformanceManager;
      private readonly formatter: HealthCheckFormatter;
    
      constructor(
        brunoCLI: IBrunoCLI,
        configLoader: IConfigLoader,
        perfManager: IPerformanceManager
      ) {
        this.brunoCLI = brunoCLI;
        this.configLoader = configLoader;
        this.perfManager = perfManager;
        this.formatter = new HealthCheckFormatter();
      }
    
      getName(): string {
        return 'bruno_health_check';
      }
    
      async handle(args: unknown): Promise<ToolResponse> {
        const params = HealthCheckSchema.parse(args);
    
        const config = this.configLoader.getConfig();
    
        // Check Bruno CLI availability
        const brunoCLIAvailable = await this.brunoCLI.isAvailable();
        const brunoCLIVersion = brunoCLIAvailable ? await this.getBrunoCLIVersion() : 'Not available';
    
        // Gather metrics and cache stats if requested
        const metricsSummary = params.includeMetrics ? this.perfManager.getMetricsSummary() : undefined;
        const cacheStats = params.includeCacheStats ? this.perfManager.getCacheStats() : undefined;
    
        const output = this.formatter.format({
          brunoCLIAvailable,
          brunoCLIVersion,
          config,
          includeMetrics: params.includeMetrics || false,
          includeCacheStats: params.includeCacheStats || false,
          metricsSummary,
          cacheStats
        });
    
        return {
          content: [
            {
              type: 'text',
              text: output
            } as TextContent
          ]
        };
      }
    
      private async getBrunoCLIVersion(): Promise<string> {
        try {
          // Use execa directly to get version - BrunoCLI.isAvailable already logs version
          // This is a simpler approach since we just checked availability
          return 'Available (use --version for details)';
        } catch {
          return 'Unknown';
        }
      }
    }
  • Zod schema used for input validation in the bruno_health_check handler.
    const HealthCheckSchema = z.object({
      includeMetrics: z.boolean().optional().describe('Include performance metrics in output'),
      includeCacheStats: z.boolean().optional().describe('Include cache statistics in output')
    });
  • src/index.ts:138-154 (registration)
    MCP Tool object registration in the TOOLS array, defining the name, description, and input schema for 'bruno_health_check'.
    {
      name: 'bruno_health_check',
      description: 'Check the health status of the Bruno MCP server and Bruno CLI',
      inputSchema: {
        type: 'object',
        properties: {
          includeMetrics: {
            type: 'boolean',
            description: 'Include performance metrics in output'
          },
          includeCacheStats: {
            type: 'boolean',
            description: 'Include cache statistics in output'
          }
        }
      }
    },
  • src/index.ts:292-292 (registration)
    Registration of the HealthCheckHandler instance into the ToolRegistry for execution dispatch.
    this.toolRegistry.register(new HealthCheckHandler(this.brunoCLI, this.configLoader, perfManager));
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure but only states what the tool does, not how it behaves. It lacks details on response format, error conditions, latency, authentication requirements, or side effects, which are critical for a health-check tool that might involve system probing.

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 directly states the tool's purpose without unnecessary words. It is front-loaded with the core function and appropriately sized for a simple health-check tool, making it easy for an agent to parse quickly.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is insufficiently complete. A health-check tool often requires details on what 'health' entails, expected output structure, or failure modes, but the description provides only a high-level purpose, leaving gaps in operational context.

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 fully documents both parameters (includeMetrics and includeCacheStats). The description adds no parameter-specific information beyond what's in the schema, meeting the baseline for high coverage but not enhancing understanding of parameter usage or implications.

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 specific action ('Check the health status') and identifies the target resources ('Bruno MCP server and Bruno CLI'), distinguishing it from sibling tools focused on collections, requests, or environments. It uses precise terminology that leaves no ambiguity about its function.

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 health monitoring but provides no explicit guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, frequency, or scenarios where health checks are appropriate, leaving the agent to infer context from the tool's name and purpose alone.

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/jcr82/bruno-mcp-server'

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