Skip to main content
Glama
bizino

BOS MCP Server

by bizino

bos_customer_count

Retrieve the total number of customers, optionally filtered by status.

Instructions

Get total customer count with optional filters

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNo

Implementation Reference

  • Handler for bos_customer_count: calls GET /mcp/customers/count with optional status filter
    {
      name: 'bos_customer_count',
      description: 'Get total customer count with optional filters',
      schema: { status: { type: 'string', optional: true } },
      handler: async (args, client) => client.get('/mcp/customers/count', args),
    },
  • Input schema for bos_customer_count: optional status filter
    schema: { status: { type: 'string', optional: true } },
  • src/index.ts:54-76 (registration)
    Tools are registered via a loop over allTools array, calling server.tool() with name, description, zod schema, and handler execution
    // Register all tools with proper Zod schemas
    for (const tool of allTools) {
      const zodSchema = toZodSchema(tool.schema);
    
      server.tool(
        tool.name,
        tool.description,
        zodSchema.shape,
        async (args: any) => {
          try {
            const result = await tool.handler(args, client);
            return {
              content: [{ type: 'text' as const, text: JSON.stringify(result, null, 2) }],
            };
          } catch (error: any) {
            return {
              content: [{ type: 'text' as const, text: JSON.stringify({ error: error.message || 'Unknown error' }) }],
              isError: true,
            };
          }
        }
      );
    }
  • src/index.ts:36-36 (registration)
    customerTools (containing bos_customer_count) are spread into the allTools array for registration
    ...customerTools,
  • toZodSchema converts simple 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);
    }
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 says 'Get' which implies a read operation, but lacks details on authorization, rate limits, or any side effects. The description adds minimal behavioral context beyond the bare action.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence with no waste. However, it sacrifices necessary detail for brevity, making it under-specified for an agent to use correctly.

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?

For a tool with one optional parameter and no output schema, the description should explain the return format and filter behavior. It does not, and it fails to reference sibling tools or provide enough context for an agent to select it appropriately.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate. It mentions 'optional filters' but does not describe the 'status' parameter, its accepted values, or how it affects the count. This fails to add meaningful information beyond the schema field.

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?

Description uses a specific verb 'Get' and resource 'total customer count', and mentions optional filters. It clearly states the tool's core function, though it does not differentiate from sibling tools like bos_customer_count_by_status.

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 explicit guidance on when to use this tool versus alternatives like bos_customer_count_by_status or bos_customer_list. The description is too brief to inform about appropriate usage contexts.

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