Skip to main content
Glama
bizino

BOS MCP Server

by bizino

boscli_system_git_status

Check the current git repository status including branch, commit hash, and list of changed files.

Instructions

Get BOS git repository status - branch, commit, changed files

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler for boscli_system_git_status - calls client.get('/boscli/system/git-status')
    {
      name: 'boscli_system_git_status',
      description: 'Get BOS git repository status - branch, commit, changed files',
      schema: {},
      handler: async (_, client) => client.get('/boscli/system/git-status'),
    },
  • The schema for boscli_system_git_status - empty object, no parameters needed
    schema: {},
  • The systemTools array definition that includes all system tool registrations, including boscli_system_git_status
    export const systemTools: McpTool[] = [
      {
        name: 'boscli_system_info',
        description: 'Get BOS system information - version, PHP, Laravel, environment',
        schema: {},
        handler: async (_, client) => client.get('/boscli/system/info'),
      },
      {
        name: 'boscli_system_logs',
        description: 'Read recent BOS log entries',
        schema: {
          lines: { type: 'number', optional: true },
          level: { type: 'string', enum: ['error', 'warning', 'info'], optional: true },
        },
        handler: async (args, client) => client.get('/boscli/system/logs', args),
      },
      {
        name: 'boscli_system_git_status',
        description: 'Get BOS git repository status - branch, commit, changed files',
        schema: {},
        handler: async (_, client) => client.get('/boscli/system/git-status'),
      },
      {
        name: 'boscli_system_deploy_status',
        description: 'Get deployment status for BOS servers',
        schema: { customer: { type: 'string', optional: true } },
        handler: async (args, client) => client.get('/boscli/system/deploy-status', args),
      },
    ];
  • src/index.ts:27-76 (registration)
    Tools are imported and spread into allTools array, then registered via server.tool() in the registration loop
    const allTools: McpTool[] = [
      ...healthTools,
      ...moduleTools,
      ...routeTools,
      ...cacheTools,
      ...systemTools,
      ...productTools,
      ...orderTools,
      ...cartTools,
      ...customerTools,
      ...inventoryTools,
      ...voucherTools,
      ...loyaltyTools,
      ...storeTools,
      ...checkoutTools,
      ...promotionTools,
      ...engagementTools,
      ...erpTools,
      ...smartTools,
    ];
    
    const client = new BosApiClient();
    const server = new McpServer({
      name: 'bos-mcp',
      version: '1.0.0',
    });
    
    // 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,
            };
          }
        }
      );
    }
  • The client.get() method that executes the actual HTTP GET request to the BOS API endpoint
    async get<T>(path: string, params?: Record<string, any>): Promise<T> {
      return this.request<T>('GET', path, undefined, params);
    }
Behavior2/5

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

No annotations are present, so the description must compensate. It implies a read operation ('Get') but does not explicitly state it is read-only, non-destructive, or safe. It fails to disclose potential side effects, permission requirements, or rate limits.

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 sentence containing no unnecessary words. It is front-loaded with the verb and resource, and every element adds value.

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

Completeness5/5

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

For a simple status tool with no parameters and no output schema, the description adequately explains what information is returned (branch, commit, changed files). It is complete for its purpose.

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 zero parameters, so schema coverage is 100% vacuously. Per guidelines, baseline is 4 for no parameters. The description does not need to add parameter meaning.

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 tool retrieves BOS git repository status, specifying branch, commit, and changed files. It uses a specific verb ('Get') and resource ('git status'), and is distinct from sibling tools like boscli_system_info or boscli_system_deploy_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 guidance is provided on when to use this tool versus alternatives, nor any context about prerequisites or exclusions. The description only states what it does, leaving the agent without usage recommendations.

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