BetterDB MCP

Instructions

Implementation Reference

• packages/mcp/src/index.ts:163-182 (handler)

  The tool 'list_instances' is defined and registered here, calling the API to fetch instances and formatting the output.

  server.tool(
    'list_instances',
    'List all Valkey/Redis instances registered in BetterDB. Shows connection status and capabilities.',
    {},
    async () => {
      const data = await apiFetch('/mcp/instances') as { instances: Array<{ id: string; name: string; isDefault: boolean; isConnected: boolean; [key: string]: unknown }> };
      const lines = data.instances.map((inst) => {
        const active = inst.id === activeInstanceId ? ' [ACTIVE]' : '';
        const status = inst.isConnected ? 'connected' : 'disconnected';
        return `${inst.id} - ${inst.name} (${status})${inst.isDefault ? ' [default]' : ''}${active}`;
      });
      return {
        content: [{ type: 'text' as const, text: lines.join('\n') || 'No instances found.' }],
      };
    },
  );
  
  server.tool(
    'select_instance',
    'Select which instance subsequent tool calls operate on.',

• apps/api/src/mcp/mcp.controller.ts:67-76 (handler)

  This is the API controller handler that provides the data to the 'list_instances' MCP tool.

  @Get('instances')
  async listInstances() {
    const list = this.registry.list();
    return {
      instances: list.map((c) => ({
        id: c.id,
        name: c.name,
        host: c.host,
        port: c.port,
        isDefault: c.isDefault,