Skip to main content
Glama

boj_health

Check the operational status of the BoJ-server to verify its availability and functionality.

Instructions

Check BoJ server health status

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The fetchHealth function that retrieves the status of the BoJ server.
    async function fetchHealth() {
      try {
        const res = await fetch(`${BOJ_BASE}/health`);
        return await res.json();
      } catch {
        return { status: "offline", message: "BoJ REST API not reachable. Start the server with: systemctl --user start boj-server" };
      }
    }
  • Registration of the boj_health tool.
    tools.push({
      name: "boj_health",
      description: "Check BoJ server health status",
      inputSchema: { type: "object", properties: {} },
    });
  • The switch case handler in the main tool execution logic for boj_health.
    case "boj_health": {
      const health = await fetchHealth();
      sendResult(id, {
        content: [
          { type: "text", text: JSON.stringify(health, null, 2) },
        ],
      });
      break;
    }
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 of behavioral disclosure. It states the action ('Check') but doesn't describe what the check entails (e.g., ping, status codes, uptime), what the output might look like, or any side effects like rate limits. This leaves significant gaps for an agent to understand the tool's behavior.

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 with no wasted words. It's front-loaded with the core action and resource, making it easy to scan and understand quickly. This is an excellent example of conciseness.

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 output schema, no annotations), the description is minimally complete. It states what the tool does but lacks details on behavior and usage context. For a health check tool, more information on expected outputs or typical use cases would enhance completeness, but it's adequate for basic understanding.

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 absence of inputs. The description doesn't need to add parameter details, and it correctly implies no inputs are required, aligning with the schema. A baseline of 4 is appropriate for a zero-parameter tool.

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 ('Check') and resource ('BoJ server health status'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools, as none appear to be health-check related, so this is adequate but not exceptional.

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?

No guidance is provided on when to use this tool versus alternatives. The description lacks context about when health checks are appropriate, such as after deployment or during troubleshooting, which would help an agent decide when to invoke it.

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/hyperpolymath/boj-server'

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