Skip to main content
Glama
bizino

BOS MCP Server

by bizino

boscli_health_schema

Check BOS database schema integrity to identify issues and ensure data consistency.

Instructions

Check BOS database schema integrity

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for boscli_health_schema tool - makes GET request to /boscli/health/schema endpoint via BosApiClient
      name: 'boscli_health_schema',
      description: 'Check BOS database schema integrity',
      schema: {},
      handler: async (_, client) => client.get('/boscli/health/schema'),
    },
  • Empty schema object - no input parameters required for this tool
    schema: {},
  • healthTools array export containing boscli_health_schema and other health check tools
    export const healthTools: McpTool[] = [
      {
        name: 'boscli_health_check',
        description: 'Full BOS system health check - modules, database, cache, routes',
        schema: {},
        handler: async (_, client) => client.get('/boscli/health'),
      },
      {
        name: 'boscli_health_modules',
        description: 'Check health of all BOS modules',
        schema: {},
        handler: async (_, client) => client.get('/boscli/health/modules'),
      },
      {
        name: 'boscli_health_database',
        description: 'Check BOS database connectivity',
        schema: {},
        handler: async (_, client) => client.get('/boscli/health/database'),
      },
      {
        name: 'boscli_health_cache',
        description: 'Check BOS cache systems',
        schema: {},
        handler: async (_, client) => client.get('/boscli/health/cache'),
      },
      {
        name: 'boscli_health_schema',
        description: 'Check BOS database schema integrity',
        schema: {},
        handler: async (_, client) => client.get('/boscli/health/schema'),
      },
    ];
  • src/index.ts:27-46 (registration)
    All tools combined into allTools array and registered via server.tool() loop (lines 55-61)
    const allTools: McpTool[] = [
      ...healthTools,
      ...moduleTools,
      ...routeTools,
      ...cacheTools,
      ...systemTools,
      ...productTools,
      ...orderTools,
      ...cartTools,
      ...customerTools,
      ...inventoryTools,
      ...voucherTools,
      ...loyaltyTools,
      ...storeTools,
      ...checkoutTools,
      ...promotionTools,
      ...engagementTools,
      ...erpTools,
      ...smartTools,
    ];
  • toZodSchema helper converts tool schema definitions to Zod schemas for MCP SDK registration
    export function toZodSchema(schema: Record<string, any>): z.ZodObject<any> {
      const shape: Record<string, z.ZodTypeAny> = {};
    
      for (const [key, def] of Object.entries(schema)) {
        let field: z.ZodTypeAny;
    
        switch (def.type) {
          case 'number':
            field = z.number();
            break;
          case 'boolean':
            field = z.boolean();
            break;
          case 'array':
            field = z.array(z.any());
            break;
          case 'object':
            field = z.record(z.any());
            break;
          case 'string':
          default:
            if (def.enum) {
              field = z.enum(def.enum);
            } else {
              field = z.string();
            }
            break;
        }
    
        if (def.description) {
          field = field.describe(def.description);
        }
    
        if (def.optional) {
          field = field.optional();
        }
    
        shape[key] = field;
      }
    
      return z.object(shape);
    }
Behavior1/5

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

No annotations and the description does not disclose any behavioral traits (e.g., read-only, side effects, return format). The agent has no indication of what happens when invoked.

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?

Single, front-loaded sentence with no redundant words; highly concise.

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?

Despite no parameters and no output schema, the description lacks information on what the tool returns or how to interpret the result, leaving the agent underinformed.

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?

Input schema has no parameters, and schema description coverage is 100% (vacuously). The description adds no value beyond the schema, earning the baseline 3.

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 specific resource 'BOS database schema integrity', distinguishing it from sibling health tools like boscli_health_cache or boscli_health_database.

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 on when to use this tool versus other health or non-health tools, nor any mention of prerequisites or context.

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/bizino/bos-mcp'

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