@pixelbyte-software/pixcode 1.30.2 → 1.31.0

package/server/modules/providers/shared/mcp/mcp.provider.ts

@@ -1,151 +1,151 @@
-import path from 'node:path';
-
-import type { IProviderMcp } from '@/shared/interfaces.js';
-import type { LLMProvider, McpScope, McpTransport, ProviderMcpServer, UpsertProviderMcpServerInput } from '@/shared/types.js';
-import { AppError } from '@/shared/utils.js';
-
-const resolveWorkspacePath = (workspacePath?: string): string =>
-  path.resolve(workspacePath ?? process.cwd());
-
-const normalizeServerName = (name: string): string => {
-  const normalized = name.trim();
-  if (!normalized) {
-    throw new AppError('MCP server name is required.', {
-      code: 'MCP_SERVER_NAME_REQUIRED',
-      statusCode: 400,
-    });
-  }
-
-  return normalized;
-};
-
-/**
- * Shared MCP provider for provider-specific config readers/writers.
- */
-export abstract class McpProvider implements IProviderMcp {
-  protected readonly provider: LLMProvider;
-  protected readonly supportedScopes: McpScope[];
-  protected readonly supportedTransports: McpTransport[];
-
-  protected constructor(
-    provider: LLMProvider,
-    supportedScopes: McpScope[],
-    supportedTransports: McpTransport[],
-  ) {
-    this.provider = provider;
-    this.supportedScopes = supportedScopes;
-    this.supportedTransports = supportedTransports;
-  }
-
-  async listServers(options?: { workspacePath?: string }): Promise<Record<McpScope, ProviderMcpServer[]>> {
-    const grouped: Record<McpScope, ProviderMcpServer[]> = {
-      user: [],
-      local: [],
-      project: [],
-    };
-
-    for (const scope of this.supportedScopes) {
-      grouped[scope] = await this.listServersForScope(scope, options);
-    }
-
-    return grouped;
-  }
-
-  async listServersForScope(
-    scope: McpScope,
-    options?: { workspacePath?: string },
-  ): Promise<ProviderMcpServer[]> {
-    if (!this.supportedScopes.includes(scope)) {
-      return [];
-    }
-
-    const workspacePath = resolveWorkspacePath(options?.workspacePath);
-    const scopedServers = await this.readScopedServers(scope, workspacePath);
-    return Object.entries(scopedServers)
-      .map(([name, rawConfig]) => this.normalizeServerConfig(scope, name, rawConfig))
-      .filter((entry): entry is ProviderMcpServer => entry !== null);
-  }
-
-  async upsertServer(input: UpsertProviderMcpServerInput): Promise<ProviderMcpServer> {
-    const scope = input.scope ?? 'project';
-    this.assertScopeAndTransport(scope, input.transport);
-
-    const workspacePath = resolveWorkspacePath(input.workspacePath);
-    const normalizedName = normalizeServerName(input.name);
-    const scopedServers = await this.readScopedServers(scope, workspacePath);
-    scopedServers[normalizedName] = this.buildServerConfig(input);
-    await this.writeScopedServers(scope, workspacePath, scopedServers);
-
-    return {
-      provider: this.provider,
-      name: normalizedName,
-      scope,
-      transport: input.transport,
-      command: input.command,
-      args: input.args,
-      env: input.env,
-      cwd: input.cwd,
-      url: input.url,
-      headers: input.headers,
-      envVars: input.envVars,
-      bearerTokenEnvVar: input.bearerTokenEnvVar,
-      envHttpHeaders: input.envHttpHeaders,
-    };
-  }
-
-  async removeServer(
-    input: { name: string; scope?: McpScope; workspacePath?: string },
-  ): Promise<{ removed: boolean; provider: LLMProvider; name: string; scope: McpScope }> {
-    const scope = input.scope ?? 'project';
-    this.assertScope(scope);
-
-    const workspacePath = resolveWorkspacePath(input.workspacePath);
-    const normalizedName = normalizeServerName(input.name);
-    const scopedServers = await this.readScopedServers(scope, workspacePath);
-    const removed = Object.prototype.hasOwnProperty.call(scopedServers, normalizedName);
-    if (removed) {
-      delete scopedServers[normalizedName];
-      await this.writeScopedServers(scope, workspacePath, scopedServers);
-    }
-
-    return { removed, provider: this.provider, name: normalizedName, scope };
-  }
-
-  protected abstract readScopedServers(
-    scope: McpScope,
-    workspacePath: string,
-  ): Promise<Record<string, unknown>>;
-
-  protected abstract writeScopedServers(
-    scope: McpScope,
-    workspacePath: string,
-    servers: Record<string, unknown>,
-  ): Promise<void>;
-
-  protected abstract buildServerConfig(input: UpsertProviderMcpServerInput): Record<string, unknown>;
-
-  protected abstract normalizeServerConfig(
-    scope: McpScope,
-    name: string,
-    rawConfig: unknown,
-  ): ProviderMcpServer | null;
-
-  protected assertScope(scope: McpScope): void {
-    if (!this.supportedScopes.includes(scope)) {
-      throw new AppError(`Provider "${this.provider}" does not support "${scope}" MCP scope.`, {
-        code: 'MCP_SCOPE_NOT_SUPPORTED',
-        statusCode: 400,
-      });
-    }
-  }
-
-  protected assertScopeAndTransport(scope: McpScope, transport: McpTransport): void {
-    this.assertScope(scope);
-    if (!this.supportedTransports.includes(transport)) {
-      throw new AppError(`Provider "${this.provider}" does not support "${transport}" MCP transport.`, {
-        code: 'MCP_TRANSPORT_NOT_SUPPORTED',
-        statusCode: 400,
-      });
-    }
-  }
-}
+import path from 'node:path';
+
+import type { IProviderMcp } from '@/shared/interfaces.js';
+import type { LLMProvider, McpScope, McpTransport, ProviderMcpServer, UpsertProviderMcpServerInput } from '@/shared/types.js';
+import { AppError } from '@/shared/utils.js';
+
+const resolveWorkspacePath = (workspacePath?: string): string =>
+  path.resolve(workspacePath ?? process.cwd());
+
+const normalizeServerName = (name: string): string => {
+  const normalized = name.trim();
+  if (!normalized) {
+    throw new AppError('MCP server name is required.', {
+      code: 'MCP_SERVER_NAME_REQUIRED',
+      statusCode: 400,
+    });
+  }
+
+  return normalized;
+};
+
+/**
+ * Shared MCP provider for provider-specific config readers/writers.
+ */
+export abstract class McpProvider implements IProviderMcp {
+  protected readonly provider: LLMProvider;
+  protected readonly supportedScopes: McpScope[];
+  protected readonly supportedTransports: McpTransport[];
+
+  protected constructor(
+    provider: LLMProvider,
+    supportedScopes: McpScope[],
+    supportedTransports: McpTransport[],
+  ) {
+    this.provider = provider;
+    this.supportedScopes = supportedScopes;
+    this.supportedTransports = supportedTransports;
+  }
+
+  async listServers(options?: { workspacePath?: string }): Promise<Record<McpScope, ProviderMcpServer[]>> {
+    const grouped: Record<McpScope, ProviderMcpServer[]> = {
+      user: [],
+      local: [],
+      project: [],
+    };
+
+    for (const scope of this.supportedScopes) {
+      grouped[scope] = await this.listServersForScope(scope, options);
+    }
+
+    return grouped;
+  }
+
+  async listServersForScope(
+    scope: McpScope,
+    options?: { workspacePath?: string },
+  ): Promise<ProviderMcpServer[]> {
+    if (!this.supportedScopes.includes(scope)) {
+      return [];
+    }
+
+    const workspacePath = resolveWorkspacePath(options?.workspacePath);
+    const scopedServers = await this.readScopedServers(scope, workspacePath);
+    return Object.entries(scopedServers)
+      .map(([name, rawConfig]) => this.normalizeServerConfig(scope, name, rawConfig))
+      .filter((entry): entry is ProviderMcpServer => entry !== null);
+  }
+
+  async upsertServer(input: UpsertProviderMcpServerInput): Promise<ProviderMcpServer> {
+    const scope = input.scope ?? 'project';
+    this.assertScopeAndTransport(scope, input.transport);
+
+    const workspacePath = resolveWorkspacePath(input.workspacePath);
+    const normalizedName = normalizeServerName(input.name);
+    const scopedServers = await this.readScopedServers(scope, workspacePath);
+    scopedServers[normalizedName] = this.buildServerConfig(input);
+    await this.writeScopedServers(scope, workspacePath, scopedServers);
+
+    return {
+      provider: this.provider,
+      name: normalizedName,
+      scope,
+      transport: input.transport,
+      command: input.command,
+      args: input.args,
+      env: input.env,
+      cwd: input.cwd,
+      url: input.url,
+      headers: input.headers,
+      envVars: input.envVars,
+      bearerTokenEnvVar: input.bearerTokenEnvVar,
+      envHttpHeaders: input.envHttpHeaders,
+    };
+  }
+
+  async removeServer(
+    input: { name: string; scope?: McpScope; workspacePath?: string },
+  ): Promise<{ removed: boolean; provider: LLMProvider; name: string; scope: McpScope }> {
+    const scope = input.scope ?? 'project';
+    this.assertScope(scope);
+
+    const workspacePath = resolveWorkspacePath(input.workspacePath);
+    const normalizedName = normalizeServerName(input.name);
+    const scopedServers = await this.readScopedServers(scope, workspacePath);
+    const removed = Object.prototype.hasOwnProperty.call(scopedServers, normalizedName);
+    if (removed) {
+      delete scopedServers[normalizedName];
+      await this.writeScopedServers(scope, workspacePath, scopedServers);
+    }
+
+    return { removed, provider: this.provider, name: normalizedName, scope };
+  }
+
+  protected abstract readScopedServers(
+    scope: McpScope,
+    workspacePath: string,
+  ): Promise<Record<string, unknown>>;
+
+  protected abstract writeScopedServers(
+    scope: McpScope,
+    workspacePath: string,
+    servers: Record<string, unknown>,
+  ): Promise<void>;
+
+  protected abstract buildServerConfig(input: UpsertProviderMcpServerInput): Record<string, unknown>;
+
+  protected abstract normalizeServerConfig(
+    scope: McpScope,
+    name: string,
+    rawConfig: unknown,
+  ): ProviderMcpServer | null;
+
+  protected assertScope(scope: McpScope): void {
+    if (!this.supportedScopes.includes(scope)) {
+      throw new AppError(`Provider "${this.provider}" does not support "${scope}" MCP scope.`, {
+        code: 'MCP_SCOPE_NOT_SUPPORTED',
+        statusCode: 400,
+      });
+    }
+  }
+
+  protected assertScopeAndTransport(scope: McpScope, transport: McpTransport): void {
+    this.assertScope(scope);
+    if (!this.supportedTransports.includes(transport)) {
+      throw new AppError(`Provider "${this.provider}" does not support "${transport}" MCP transport.`, {
+        code: 'MCP_TRANSPORT_NOT_SUPPORTED',
+        statusCode: 400,
+      });
+    }
+  }
+}