connector

Overview

The @opticlm/connector provides an abstract interface that allows LLMs to connect to various fact sources including LSPs, code diagnostics, symbol definitions/references, links, and frontmatter. It offers both MCP and Vercel AI SDK implementations with comprehensive tool coverage for code analysis, navigation, editing, diagnostics, and document linking. The library features a modular provider-based architecture allowing IDEs to implement only the functionality they support.

Try asking AI

After installing, here are 5 things you can ask your AI assistant:

• goto_definition

  Navigate to the definition of a symbol.

  Try:Go to the definition of MyClassTry:Show me where this function is defined
• find_references

  Find all references to a symbol.

  Try:Find all usages of this functionTry:Show me everywhere this class is referenced
• find_file_references

  Find all references to a file across the workspace.

  Try:Find all files that import utils.jsTry:Show me all links to this document
• call_hierarchy

  Get call hierarchy for a function or method.

  Try:Show me the call hierarchy for main()Try:Find who calls this function
• apply_edit

  Apply a text edit to a file using hashline references.

  Try:Fix the typo in this functionTry:Add a new parameter to this method
• global_find

  Search for text across the entire workspace.

  Try:Find all TODO commentsTry:Search for 'api_key' in all files
• get_link_structure

  Get all links in the workspace, showing relationships between documents.

  Try:Show all links between documentsTry:Map the graph of connections between notes
• add_link

  Add a link to a document by finding a text pattern and replacing it with a link.

  Try:Link 'React' to the React documentationTry:Connect 'TypeScript' to its type definition
• get_frontmatter_structure

  Get frontmatter property values across documents.

  Try:Show all 'tags' across documentsTry:Find all documents with 'status: draft'
• set_frontmatter

  Set a frontmatter property on a document.

  Try:Add 'category: api' to this documentTry:Set the 'published' date to today
• get_diagnostics

  Get diagnostics (errors, warnings) for a specific file.

  Try:Show me all errors in index.tsTry:Check for issues in this file
• get_outline

  Get document symbols (outline) for a file.

  Try:Show me the structure of this fileTry:List all classes and functions in this document

Comparable tools

Installation

npm install @opticlm/connector

{
  "mcpServers": {
    "opticlm-connector": {
      "command": "npx",
      "args": ["@opticlm/connector"]
    }
  }
}

FAQ

What file formats does the connector support?

The connector primarily works with source code files and supports reading files in hashline format to enable safe editing operations.

How does it handle LSP integration?

It abstracts LSP functionality through providers for definitions, references, diagnostics, outlines, and more, allowing seamless integration with any LSP-compatible language server.

Compare connector with