Skip to main content
Glama
NazarLysyi

Brickognize MCP Server

by NazarLysyi

Brickognize Health Check

brickognize_health
Read-onlyIdempotent

Check if the Brickognize image recognition API is online and responsive before attempting LEGO identification tasks.

Instructions

Check whether the Brickognize image recognition API is online and responsive. Call this before recognition if you suspect the service might be down. Takes no parameters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The actual implementation of the Brickognize health check API call.
    export async function checkHealth(): Promise<HealthResponse> {
      const res = await fetch(`${BASE_URL}/health/`, {
        signal: AbortSignal.timeout(10_000),
      });
    
      if (!res.ok) {
        throw apiError(res.status, await res.text());
      }
    
      const data = await res.json();
    
      if (typeof data !== "object" || data === null) {
        throw unexpectedResponse("health endpoint did not return an object");
      }
    
      return data as HealthResponse;
    }
  • Registration of the 'brickognize_health' tool.
    export function registerHealthTool(server: McpServer): void {
      server.registerTool(
        "brickognize_health",
        {
          title: "Brickognize Health Check",
          description:
            "Check whether the Brickognize image recognition API is online and responsive. " +
            "Call this before recognition if you suspect the service might be down. Takes no parameters.",
          annotations: TOOL_ANNOTATIONS,
        },
        async () => {
          try {
            const health = await checkHealth();
            return {
              content: [{ type: "text" as const, text: JSON.stringify(health, null, 2) }],
            };
          } catch (error) {
            return {
              isError: true,
              content: [{ type: "text" as const, text: formatToolError(error) }],
            };
          }
        },
      );
    }
Behavior4/5

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

Annotations already provide strong behavioral hints (readOnly, openWorld, idempotent, non-destructive). The description adds valuable context by explaining the tool's purpose as a pre-recognition health check, which helps the agent understand when to use it. However, it doesn't mention potential response formats or error conditions that could occur if the service is down.

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 extremely concise (two sentences) and front-loaded with the core purpose. Every sentence earns its place: the first explains what the tool does, and the second provides usage guidance. There is zero wasted text.

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 the tool's simplicity (0 parameters, no output schema) and rich annotations, the description is mostly complete. It covers purpose and usage well. However, it doesn't describe what the output might look like (e.g., success/failure indicators), which could be helpful since there's no output schema.

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. The description explicitly states 'Takes no parameters,' which adds clarity beyond the empty schema. This is helpful for the agent to understand there are no inputs required, though the schema already indicates this.

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 whether the Brickognize image recognition API is online and responsive') and the resource ('Brickognize image recognition API'). It distinguishes from sibling tools (which perform recognition tasks) by focusing on health/availability rather than image identification.

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool ('Call this before recognition if you suspect the service might be down'), providing clear context and distinguishing it from the sibling recognition tools. It effectively guides the agent on the appropriate scenario for invocation.

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/NazarLysyi/brickognize-mcp'

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