@apicircle/mcp-server 1.0.8 → 1.1.0

package/dist/index.d.cts

@@ -1,9 +1,13 @@
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
+export { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
 import { z } from 'zod';
 import { WorkspaceSynced, WorkspaceLocal, MockServer, MockRuntimeEntry, McpToolName } from '@apicircle/shared';
 import { WorkspaceState, WorkspacePatch } from '@apicircle/core';
 import { WorkspaceRegistry } from '@apicircle/core/workspace/registry';
+export { MCP_PROMPTS, MCP_PROMPT_CATEGORIES, McpPrompt, McpPromptCategory } from './prompts/mcpPrompts.cjs';
+export { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
+export { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 
 interface WorkspaceProvider {
     /** Snapshot the current `{ synced, local }` pair. */
@@ -171,6 +175,20 @@ declare class FileBackedWorkspaceProvider implements WorkspaceProvider {
     }): Promise<WorkspaceState>;
 }
 
+declare class GitBackedWorkspaceProvider implements WorkspaceProvider {
+    private readonly dir;
+    constructor(dir: string);
+    read(): Promise<WorkspaceState>;
+    apply(patch: WorkspacePatch): Promise<{
+        state: WorkspaceState;
+        changedIds: string[];
+    }>;
+    write(next: {
+        synced?: WorkspaceSynced;
+        local?: WorkspaceLocal;
+    }): Promise<WorkspaceState>;
+}
+
 declare class MultiWorkspaceProvider implements Workspaces {
     private readonly registryRoot;
     /** Last-known active workspace id. Refreshed every time the lazy
@@ -229,6 +247,52 @@ declare class InProcessMockController implements MockController {
     }>>;
 }
 
+type AiClient = 'claude-desktop' | 'claude-code' | 'codex' | 'cursor' | 'continue' | 'cline' | 'zed' | 'windsurf' | 'github-copilot' | 'chatgpt' | 'generic';
+declare const AI_CLIENTS: readonly AiClient[];
+/**
+ * Two byte-identical-but-for-path-escaping renderings of the same snippet.
+ *
+ *   - `forwardSlash`: workspace path uses `/` separators on Windows
+ *     (`"C:/Users/.../workspaces"`). No backslash escapes needed — easier
+ *     to read, accepted by Node, Electron, and Windows file APIs.
+ *   - `escaped`: literal OS path. On Windows that means `\\` escapes
+ *     inside quoted strings (JSON and TOML both use `\` as the escape
+ *     character).
+ *
+ * On POSIX both strings are byte-identical and `identical` is `true` — the
+ * UI uses that flag to suppress the variant picker.
+ */
+interface ConfigSnippetVariants {
+    forwardSlash: string;
+    escaped: string;
+    identical: boolean;
+}
+/**
+ * Build the snippet for a given AI client + workspace path. Most clients
+ * use JSON with `mcpServers: { apicircle: ... }`; Codex uses TOML with
+ * `[mcp_servers.apicircle]`. The `client` arg selects the format.
+ */
+declare function buildSnippetVariants(client: AiClient, binary: string, workspace: string): ConfigSnippetVariants;
+/**
+ * Host-environment shape the config-path resolver depends on. Both the
+ * desktop main process and the VS Code extension run on Node — they pass
+ * the standard `os.homedir()` / `process.platform` / `process.env.APPDATA`
+ * values straight through. Tests pin them explicitly.
+ */
+interface ConfigPathEnv {
+    /** e.g. `os.homedir()` */
+    homedir: string;
+    /** `process.platform` — one of "darwin" / "win32" / "linux" / ... */
+    platform: NodeJS.Platform;
+    /** Windows-only: `process.env.APPDATA`, used by Claude Desktop's config. */
+    appdata?: string;
+}
+/**
+ * Conventional path of the config file for each client on the current OS,
+ * or `null` if the client has no fixed location (manual paste).
+ */
+declare function resolveAiClientConfigPath(client: AiClient, env: ConfigPathEnv): string | null;
+
 interface CreateMcpServerOptions {
     /**
      * Provider for the ACTIVE workspace. Tools that consume `ctx.workspace`
@@ -258,4 +322,4 @@ interface CreateMcpServerOptions {
  */
 declare function createMcpServer(options: CreateMcpServerOptions): McpHost;
 
-export { type AnyToolDef, type CreateMcpServerOptions, FileBackedWorkspaceProvider, InMemoryWorkspaceProvider, InProcessMockController, McpHost, type MockController, MultiWorkspaceProvider, SingleWorkspaceAdapter, type StartMockResult, TOOL_REGISTRY, type ToolDef, type ToolHandlerContext, WorkspaceNotFoundError, type WorkspaceProvider, type WorkspaceSummary, type Workspaces, createMcpServer, getTool };
+export { AI_CLIENTS, type AiClient, type AnyToolDef, type ConfigPathEnv, type ConfigSnippetVariants, type CreateMcpServerOptions, FileBackedWorkspaceProvider, GitBackedWorkspaceProvider, InMemoryWorkspaceProvider, InProcessMockController, McpHost, type MockController, MultiWorkspaceProvider, SingleWorkspaceAdapter, type StartMockResult, TOOL_REGISTRY, type ToolDef, type ToolHandlerContext, WorkspaceNotFoundError, type WorkspaceProvider, type WorkspaceSummary, type Workspaces, buildSnippetVariants, createMcpServer, getTool, resolveAiClientConfigPath };

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
+export { Transport } from '@modelcontextprotocol/sdk/shared/transport.js';
 import { z } from 'zod';
 import { WorkspaceSynced, WorkspaceLocal, MockServer, MockRuntimeEntry, McpToolName } from '@apicircle/shared';
 import { WorkspaceState, WorkspacePatch } from '@apicircle/core';
 import { WorkspaceRegistry } from '@apicircle/core/workspace/registry';
+export { MCP_PROMPTS, MCP_PROMPT_CATEGORIES, McpPrompt, McpPromptCategory } from './prompts/mcpPrompts.js';
+export { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
+export { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 
 interface WorkspaceProvider {
     /** Snapshot the current `{ synced, local }` pair. */
@@ -171,6 +175,20 @@ declare class FileBackedWorkspaceProvider implements WorkspaceProvider {
     }): Promise<WorkspaceState>;
 }
 
+declare class GitBackedWorkspaceProvider implements WorkspaceProvider {
+    private readonly dir;
+    constructor(dir: string);
+    read(): Promise<WorkspaceState>;
+    apply(patch: WorkspacePatch): Promise<{
+        state: WorkspaceState;
+        changedIds: string[];
+    }>;
+    write(next: {
+        synced?: WorkspaceSynced;
+        local?: WorkspaceLocal;
+    }): Promise<WorkspaceState>;
+}
+
 declare class MultiWorkspaceProvider implements Workspaces {
     private readonly registryRoot;
     /** Last-known active workspace id. Refreshed every time the lazy
@@ -229,6 +247,52 @@ declare class InProcessMockController implements MockController {
     }>>;
 }
 
+type AiClient = 'claude-desktop' | 'claude-code' | 'codex' | 'cursor' | 'continue' | 'cline' | 'zed' | 'windsurf' | 'github-copilot' | 'chatgpt' | 'generic';
+declare const AI_CLIENTS: readonly AiClient[];
+/**
+ * Two byte-identical-but-for-path-escaping renderings of the same snippet.
+ *
+ *   - `forwardSlash`: workspace path uses `/` separators on Windows
+ *     (`"C:/Users/.../workspaces"`). No backslash escapes needed — easier
+ *     to read, accepted by Node, Electron, and Windows file APIs.
+ *   - `escaped`: literal OS path. On Windows that means `\\` escapes
+ *     inside quoted strings (JSON and TOML both use `\` as the escape
+ *     character).
+ *
+ * On POSIX both strings are byte-identical and `identical` is `true` — the
+ * UI uses that flag to suppress the variant picker.
+ */
+interface ConfigSnippetVariants {
+    forwardSlash: string;
+    escaped: string;
+    identical: boolean;
+}
+/**
+ * Build the snippet for a given AI client + workspace path. Most clients
+ * use JSON with `mcpServers: { apicircle: ... }`; Codex uses TOML with
+ * `[mcp_servers.apicircle]`. The `client` arg selects the format.
+ */
+declare function buildSnippetVariants(client: AiClient, binary: string, workspace: string): ConfigSnippetVariants;
+/**
+ * Host-environment shape the config-path resolver depends on. Both the
+ * desktop main process and the VS Code extension run on Node — they pass
+ * the standard `os.homedir()` / `process.platform` / `process.env.APPDATA`
+ * values straight through. Tests pin them explicitly.
+ */
+interface ConfigPathEnv {
+    /** e.g. `os.homedir()` */
+    homedir: string;
+    /** `process.platform` — one of "darwin" / "win32" / "linux" / ... */
+    platform: NodeJS.Platform;
+    /** Windows-only: `process.env.APPDATA`, used by Claude Desktop's config. */
+    appdata?: string;
+}
+/**
+ * Conventional path of the config file for each client on the current OS,
+ * or `null` if the client has no fixed location (manual paste).
+ */
+declare function resolveAiClientConfigPath(client: AiClient, env: ConfigPathEnv): string | null;
+
 interface CreateMcpServerOptions {
     /**
      * Provider for the ACTIVE workspace. Tools that consume `ctx.workspace`
@@ -258,4 +322,4 @@ interface CreateMcpServerOptions {
  */
 declare function createMcpServer(options: CreateMcpServerOptions): McpHost;
 
-export { type AnyToolDef, type CreateMcpServerOptions, FileBackedWorkspaceProvider, InMemoryWorkspaceProvider, InProcessMockController, McpHost, type MockController, MultiWorkspaceProvider, SingleWorkspaceAdapter, type StartMockResult, TOOL_REGISTRY, type ToolDef, type ToolHandlerContext, WorkspaceNotFoundError, type WorkspaceProvider, type WorkspaceSummary, type Workspaces, createMcpServer, getTool };
+export { AI_CLIENTS, type AiClient, type AnyToolDef, type ConfigPathEnv, type ConfigSnippetVariants, type CreateMcpServerOptions, FileBackedWorkspaceProvider, GitBackedWorkspaceProvider, InMemoryWorkspaceProvider, InProcessMockController, McpHost, type MockController, MultiWorkspaceProvider, SingleWorkspaceAdapter, type StartMockResult, TOOL_REGISTRY, type ToolDef, type ToolHandlerContext, WorkspaceNotFoundError, type WorkspaceProvider, type WorkspaceSummary, type Workspaces, buildSnippetVariants, createMcpServer, getTool, resolveAiClientConfigPath };