@opticlm/connector 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 EFLKumo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,499 @@
+# MCP LSP Driver SDK
+
+A TypeScript SDK that bridges Language Server Protocol (LSP) capabilities with the Model Context Protocol (MCP). Designed for IDE plugin developers building AI-assisted coding tools for VS Code, JetBrains, and other editors.
+
+## Table of Contents
+
+- [Core Philosophy](#core-philosophy)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [MCP Tools](#mcp-tools)
+- [Tool Callbacks](#tool-callbacks)
+- [MCP Resources](#mcp-resources)
+- [Auto-Complete for File Paths](#auto-complete-for-file-paths)
+- [Subscription and Change Notifications](#subscription-and-change-notifications)
+- [Symbol Resolution](#symbol-resolution)
+- [Pipe IPC (Out-of-Process)](#pipe-ipc-out-of-process)
+- [LSP Client (Built-in)](#lsp-client-built-in)
+- [Requirements](#requirements)
+- [License](#license)
+
+## Core Philosophy
+
+- **Fuzzy-to-Exact Resolution**: LLMs interact via semantic anchors (`symbolName`, `lineHint`), and the SDK resolves them to precise coordinates
+- **Disk-Based Truth**: All read operations reflect the state of files on disk, ignoring unsaved IDE buffers
+- **High Abstraction**: Beyond LSP, it also provides functionality related to something like dual chains (graph capability) and metadata (frontmatter capability).
+
+## Installation
+
+```bash
+npm install @opticlm/connector
+# or
+pnpm add @opticlm/connector
+```
+
+## Quick Start
+
+Providers are installed one at a time onto an MCP server using `install()` from `@opticlm/connector/mcp`. Each call registers the tools and resources for that specific provider. Providers that depend on file access (definition, references, hierarchy, edit) receive a `fileAccess` option.
+
+```typescript
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
+import { install } from '@opticlm/connector/mcp'
+import * as fs from 'fs/promises'
+
+// 1. Create your MCP server
+const server = new McpServer({
+  name: 'my-ide-mcp-server',
+  version: '1.0.0'
+})
+
+// 2. Implement File Access
+const fileAccess = {
+  readFile: async (uri: string) => {
+    return await fs.readFile(uri, 'utf-8')
+  },
+  readDirectory: (uri: string) => yourIDE.workspace.readDirectory(uri),
+}
+
+// 3. Implement Edit Provider
+const edit = {
+  // Show diff in your IDE and get user approval
+  previewAndApplyEdits: async (operation) => {
+    return await showDiffDialog(operation)
+  },
+}
+
+// 4. Implement LSP Capability Providers
+const definition = {
+  provideDefinition: async (uri, position) => {
+    return await lspClient.getDefinition(uri, position)
+  },
+}
+
+const diagnostics = {
+  provideDiagnostics: async (uri) => {
+    return await lspClient.getDiagnostics(uri)
+  },
+  getWorkspaceDiagnostics: async () => {
+    return await lspClient.getWorkspaceDiagnostics()
+  },
+  onDiagnosticsChanged: (callback) => {
+    yourIDE.onDiagnosticsChanged((uri) => callback(uri))
+  },
+}
+
+const outline = {
+  provideDocumentSymbols: async (uri) => {
+    return await lspClient.getDocumentSymbols(uri)
+  },
+}
+
+// 5. Install providers onto the server
+//    fileAccess is installed first; others receive it as an option when needed
+install(server, fileAccess)
+install(server, edit, { fileAccess })
+install(server, definition, { fileAccess })
+install(server, diagnostics, { fileAccess })
+install(server, outline, { fileAccess })
+
+// 6. Connect to transport (you control the server lifecycle)
+const transport = new StdioServerTransport()
+await server.connect(transport)
+```
+
+Each `install()` call is independent — only install the providers your IDE actually supports. The `fileAccess` option is required for providers that read files (edit, definition, references, hierarchy) and is used optionally by others for path auto-complete.
+
+## MCP Tools
+
+The SDK automatically registers tools based on which providers you install:
+
+### `goto_definition`
+
+Navigate to the definition of a symbol.
+
+### `find_references`
+
+Find all references to a symbol.
+
+### `call_hierarchy`
+
+Get call hierarchy for a function or method.
+
+### `apply_edit`
+
+Apply a text edit to a file using hashline references (requires user approval).
+
+The `files://` resource returns file content in **hashline format** — each line is prefixed with `<line>:<hash>|`, where the hash is a 2-char CRC16 digest of the line's content. To edit a file, reference lines by these hashes. If the file has changed since the last read, the hashes won't match and the edit is rejected, preventing stale overwrites.
+
+### `global_find`
+
+Search for text across the entire workspace.
+
+### `get_link_structure`
+
+Get all links in the workspace, showing relationships between documents.
+
+### `add_link`
+
+Add a link to a document by finding a text pattern and replacing it with a link.
+
+### `get_frontmatter_structure`
+
+Get frontmatter property values across documents.
+
+### `set_frontmatter`
+
+Set a frontmatter property on a document.
+
+## Tool Callbacks
+
+Each provider with tools accepts optional `onInput` and `onOutput` callbacks in its install options. These fire synchronously around each tool invocation — `onInput` before processing, `onOutput` after a successful result (not on errors).
+
+Use them for logging, telemetry, or testing:
+
+```typescript
+import { install } from '@opticlm/connector/mcp'
+
+// EditProvider — apply_edit
+install(server, editProvider, {
+  fileAccess,
+  onEditInput: (input) => {
+    console.log('edit requested:', input.uri, input.description)
+  },
+  onEditOutput: (output) => {
+    console.log('edit result:', output.success, output.message)
+  },
+})
+
+// DefinitionProvider — goto_definition + goto_type_definition
+install(server, definitionProvider, {
+  fileAccess,
+  onDefinitionInput: (input) => log('goto_definition', input),
+  onDefinitionOutput: (output) => log('goto_definition result', output.snippets.length),
+  onTypeDefinitionInput: (input) => log('goto_type_definition', input),
+  onTypeDefinitionOutput: (output) => log('goto_type_definition result', output.snippets.length),
+})
+```
+
+### Callback reference
+
+| Provider | Tool | Input callback | Output callback |
+|----------|------|----------------|-----------------|
+| `EditProvider` | `apply_edit` | `onEditInput` | `onEditOutput` |
+| `DefinitionProvider` | `goto_definition` | `onDefinitionInput` | `onDefinitionOutput` |
+| `DefinitionProvider` | `goto_type_definition` | `onTypeDefinitionInput` | `onTypeDefinitionOutput` |
+| `ReferencesProvider` | `find_references` | `onReferencesInput` | `onReferencesOutput` |
+| `HierarchyProvider` | `call_hierarchy` | `onCallHierarchyInput` | `onCallHierarchyOutput` |
+| `GlobalFindProvider` | `global_find` | `onGlobalFindInput` | `onGlobalFindOutput` |
+| `GraphProvider` | `get_link_structure` | — | `onLinkStructureOutput` |
+| `GraphProvider` | `add_link` | `onAddLinkInput` | `onAddLinkOutput` |
+| `FrontmatterProvider` | `get_frontmatter_structure` | `onFrontmatterStructureInput` | `onFrontmatterStructureOutput` |
+| `FrontmatterProvider` | `set_frontmatter` | `onSetFrontmatterInput` | `onSetFrontmatterOutput` |
+
+`get_link_structure` has no `onInput` since its input schema is empty. Resource-only providers (`FileAccessProvider`, `DiagnosticsProvider`, `OutlineProvider`) have no callbacks.
+
+## MCP Resources
+
+The SDK automatically registers resources based on which providers you install:
+
+### `diagnostics://{path}`
+
+Get diagnostics (errors, warnings) for a specific file.
+
+**Resource URI Pattern:** `diagnostics://{+path}`
+
+**Example:** `diagnostics://src/main.ts`
+
+Returns diagnostics formatted as markdown with location, severity, and message information.
+
+**Subscription Support:** If your `DiagnosticsProvider` implements `onDiagnosticsChanged`, these resources become subscribable. When diagnostics change, the driver sends resource update notifications.
+
+### `diagnostics://workspace`
+
+Get diagnostics across the entire workspace.
+
+**Resource URI:** `diagnostics://workspace`
+
+Only available if your `DiagnosticsProvider` implements the optional `getWorkspaceDiagnostics()` method.
+
+Returns workspace diagnostics grouped by file, formatted as markdown.
+
+**Subscription Support:** If your `DiagnosticsProvider` implements `onDiagnosticsChanged`, this resource becomes subscribable.
+
+### `outline://{path}`
+
+Get the document outline (symbol tree) for a file.
+
+**Resource URI Pattern:** `outline://{+path}`
+
+**Example:** `outline://src/components/Button.tsx`
+
+Returns document symbols formatted as a hierarchical markdown outline, including:
+- Symbol names and kinds (class, function, method, etc.)
+- Source locations
+- Nested children (e.g., methods within classes)
+
+No subscription support for this resource (read-only).
+
+### `files://{path}`
+
+For directories: returns directory children (git-ignored files excluded, similar to `ls`). For files: returns content in **hashline format** with optional line range and regex filtering.
+
+**Hashline format:** Each line is prefixed with `<line>:<hash>|`, where `<line>` is the 1-based line number and `<hash>` is a 2-char CRC16 hex digest of the line content. For example:
+
+```
+1:a3|function hello() {
+2:f1|  return "world"
+3:0e|}
+```
+
+These hashes serve as content-addressed anchors for the `apply_edit` tool — if the file changes between read and edit, the hash mismatch is detected and the edit is safely rejected.
+
+**Resource URI Pattern:** `files://{+path}`
+
+**Example:** `files://src`, `files://src/index.ts`, `files://src/index.ts#L1-L2`, `files://src/index.ts?pattern=^import`, `files://src/index.ts?pattern=TODO#L10-L50`
+
+No subscription support for this resource (read-only).
+
+### `outlinks://{path}`
+
+Get outgoing links from a specific file.
+
+**Resource URI Pattern:** `outlinks://{+path}`
+
+**Example:** `outlinks://notes/index.md`
+
+Returns a JSON array of links originating from the specified document.
+
+No subscription support for this resource (read-only).
+
+### `backlinks://{path}`
+
+Get incoming links (backlinks) to a specific file.
+
+**Resource URI Pattern:** `backlinks://{+path}`
+
+**Example:** `backlinks://notes/topic-a.md`
+
+Returns a JSON array of links pointing to the specified document.
+
+No subscription support for this resource (read-only).
+
+### `frontmatter://{path}`
+
+Get frontmatter metadata for a specific file.
+
+**Resource URI Pattern:** `frontmatter://{+path}`
+
+**Example:** `frontmatter://notes/index.md`
+
+Returns a JSON object containing all frontmatter properties and values for the document.
+
+No subscription support for this resource (read-only).
+
+## Auto-Complete for File Paths
+
+All resource templates with a `{+path}` variable (`files://`, `diagnostics://`, `outline://`, `outlinks://`, `backlinks://`, `frontmatter://`) support MCP auto-completion. When an MCP client calls `completion/complete` with a partial file path, the SDK uses `readDirectory` from your `FileAccessProvider` to suggest matching entries.
+
+- Completion is case-insensitive and splits input into a directory and prefix (e.g., `src/ser` reads `src/` and filters by `ser`)
+- If `readDirectory` fails (e.g., the directory doesn't exist), an empty list is returned
+- Results are capped at 100 items by the MCP SDK
+
+This works automatically — no additional configuration is needed.
+
+## Subscription and Change Notifications
+
+Providers can implement optional `onDiagnosticsChanged` and `onFileChanged` callbacks to make resources subscribable:
+
+```typescript
+import { install } from '@opticlm/connector/mcp'
+
+install(server, {
+  readFile: async (uri) => { /* ... */ },
+  readDirectory: async (path) => { /* ... */ },
+  onFileChanged: (callback) => {
+    yourIDE.onFileChanged((uri) => callback(uri))
+  },
+})
+
+install(server, {
+  provideDiagnostics: async (uri) => { /* ... */ },
+  getWorkspaceDiagnostics: async () => { /* ... */ },
+  onDiagnosticsChanged: (callback) => {
+    yourIDE.onDiagnosticsChanged((uri) => callback(uri))
+  },
+})
+```
+
+When diagnostics or files change, call the registered callback with the affected file URI. The driver will send MCP resource update notifications to subscribers.
+
+## Symbol Resolution
+
+The SDK uses a robust algorithm to handle imprecise LLM positioning:
+
+1. Target the `lineHint` (converting 1-based to 0-based)
+2. Search for `symbolName` in that line
+3. **Robustness Fallback**: If not found, scan +/- 2 lines (configurable)
+4. Use `orderHint` to select the Nth occurrence if needed
+
+Configure the search radius via the `resolverConfig` option:
+
+```typescript
+install(server, definitionProvider, {
+  fileAccess,
+  resolverConfig: {
+    lineSearchRadius: 5,  // Default: 2
+  },
+})
+```
+
+## Pipe IPC (Out-of-Process)
+
+When the MCP server runs in a separate process from the IDE plugin (e.g., spawned via stdio transport), the Pipe IPC layer lets the two communicate over a named pipe.
+
+**IDE plugin side** — expose providers:
+
+```typescript
+import { servePipe } from '@opticlm/connector'
+
+const server = await servePipe({
+  pipeName: 'my-ide-lsp',
+  fileAccess: { /* ... */ },
+  definition: { /* ... */ },
+  diagnostics: {
+    provideDiagnostics: async (uri) => { /* ... */ },
+    onDiagnosticsChanged: (callback) => { /* ... */ },
+  },
+  // Add only the providers your IDE supports
+})
+// server.pipePath        — the resolved pipe path
+// server.connectionCount — number of connected clients
+// await server.close()   — shut down
+```
+
+**MCP server side** — connect and install proxy providers:
+
+```typescript
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
+import { connectPipe } from '@opticlm/connector'
+import { install } from '@opticlm/connector/mcp'
+
+const conn = await connectPipe({
+  pipeName: 'my-ide-lsp',
+  connectTimeout: 5000,  // optional, default 5000ms
+})
+
+// conn exposes proxy providers as named fields:
+// conn.fileAccess, conn.definition, conn.diagnostics, etc.
+// conn.availableMethods lists all methods the server exposes
+
+const mcpServer = new McpServer({ name: 'my-mcp', version: '1.0.0' })
+
+if (conn.fileAccess) install(mcpServer, conn.fileAccess)
+if (conn.definition && conn.fileAccess)
+  install(mcpServer, conn.definition, { fileAccess: conn.fileAccess })
+if (conn.diagnostics && conn.fileAccess)
+  install(mcpServer, conn.diagnostics, { fileAccess: conn.fileAccess })
+// Install whichever proxy providers are available
+
+// When done:
+conn.disconnect()
+```
+
+The handshake automatically discovers which providers the server exposes and builds typed proxies. Change notifications are forwarded as push notifications to all connected clients. Multiple clients can connect to the same pipe simultaneously.
+
+## LSP Client (Built-in)
+
+For standalone MCP servers that need to communicate directly with an LSP server (e.g., when not running inside an IDE plugin), `LspClient` spawns a language server process and automatically creates capability providers based on the server's reported capabilities.
+
+```typescript
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
+import { createLspClient } from '@opticlm/connector'
+import { install } from '@opticlm/connector/mcp'
+import * as fs from 'fs/promises'
+
+// 1. Create and start the LSP client
+const lsp = createLspClient({
+  command: 'typescript-language-server',
+  args: ['--stdio'],
+  workspacePath: '/path/to/project',
+  readFile: (path) => fs.readFile(path, 'utf-8'),
+})
+
+await lsp.start()
+
+// 2. Wire providers into MCP
+const server = new McpServer({ name: 'my-mcp', version: '1.0.0' })
+
+const fileAccess = {
+  readFile: (uri: string) => fs.readFile(uri, 'utf-8'),
+  readDirectory: async () => [],
+}
+
+// Providers are automatically created based on server capabilities
+install(server, fileAccess)
+if (lsp.definition) install(server, lsp.definition, { fileAccess })
+if (lsp.references) install(server, lsp.references, { fileAccess })
+if (lsp.hierarchy)  install(server, lsp.hierarchy,  { fileAccess })
+if (lsp.outline)    install(server, lsp.outline,    { fileAccess })
+install(server, {
+  ...lsp.diagnostics,
+  onDiagnosticsChanged: lsp.onDiagnosticsChanged,
+}, { fileAccess })
+
+const transport = new StdioServerTransport()
+await server.connect(transport)
+```
+
+### `LspClientOptions`
+
+```typescript
+interface LspClientOptions {
+  command: string               // LSP server command to spawn
+  args?: string[]               // Command arguments (e.g., ['--stdio'])
+  workspacePath: string         // Absolute path to the workspace root
+  readFile: (path: string) => Promise<string>  // File reader for document sync
+  env?: Record<string, string>  // Additional environment variables
+  initializationOptions?: unknown  // LSP initializationOptions
+  documentIdleTimeout?: number  // Auto-close open docs after ms (default: 30000)
+  requestTimeout?: number       // Timeout for LSP requests in ms (default: 30000)
+}
+```
+
+### How It Works
+
+1. `start()` spawns the LSP server process and performs the initialize/initialized handshake
+2. The server's `ServerCapabilities` response determines which providers are created:
+   - `definitionProvider` &rarr; `lsp.definition`
+   - `referencesProvider` &rarr; `lsp.references`
+   - `callHierarchyProvider` &rarr; `lsp.hierarchy`
+   - `documentSymbolProvider` &rarr; `lsp.outline`
+   - Diagnostics are always available (via `textDocument/publishDiagnostics` notifications)
+3. Providers that the server does not support remain `undefined`
+4. Documents are automatically opened/closed with the server on demand, with an idle timeout for cleanup
+
+### Lifecycle
+
+```typescript
+const lsp = createLspClient({ /* ... */ })
+
+lsp.getState()  // 'idle'
+await lsp.start()
+lsp.getState()  // 'running'
+
+// Use lsp.definition, lsp.references, etc.
+
+await lsp.stop()
+lsp.getState()  // 'dead'
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+- TypeScript >= 5.7.0
+
+## License
+
+MIT