Back to Oh My Openagent

codex-lsp

packages/omo-codex/plugin/components/lsp/README.md

4.5.124.3 KB
Original Source

codex-lsp

Codex plugin that ports the standalone LSP runtime from pi-lsp-client. It gives Codex post-edit diagnostics plus explicit MCP tools for language-aware code work.

Architecture

The LSP runtime moved to lsp-tools-mcp and is consumed from this repository's root packages/lsp-tools-mcp/ package.

  • codex-lsp keeps Codex-specific integration (hook post-tool-use, plugin metadata, package wiring).
  • lsp-tools-mcp owns MCP runtime, LSP manager, and tool implementations.
  • src/cli.ts routes mcp to upstream runtime and keeps hook post-tool-use local.

Behavior

CaseResult
apply_patch succeedsparses tool_input.command, extracts added/updated/moved files, and checks each with LSP error diagnostics
write / edit / multiedit succeedschecks path, filePath, or file_path aliases
diagnostics contain errorsreturns Codex PostToolUse blocking feedback and injects the same diagnostics as additional context so Codex fixes the file
no diagnosticsemits no hook output
unsupported extensionemits no hook output
missing configured language serversurfaces the install/config message through hook or MCP output

Deletes are ignored because they cannot introduce new diagnostics.

MCP Tools

  • lsp.status
  • lsp.diagnostics
  • lsp.goto_definition
  • lsp.find_references
  • lsp.symbols
  • lsp.prepare_rename
  • lsp.rename

lsp.rename applies the returned workspace edit to files. Use lsp.prepare_rename first when possible.

Configuration

Project config:

text
.codex/lsp-client.json

User config:

text
~/.codex/lsp-client.json

Example:

json
{
	"lsp": {
		"typescript": {
			"command": ["typescript-language-server", "--stdio"],
			"extensions": [".ts", ".tsx", ".js", ".jsx"]
		}
	}
}

Built-in server definitions are used when no custom config overrides them. lsp.status shows which configured servers are installed or missing.

Codex Plugin

The plugin ships:

  • .codex-plugin/plugin.json for Codex plugin discovery.
  • .mcp.json for the lsp MCP server.
  • hooks/hooks.json for the PostToolUse diagnostics hook.
  • skills/lsp/SKILL.md with MCP usage guidance.

The runtime depends on @code-yeongyu/lsp-tools-mcp via file:../../../../lsp-tools-mcp, so marketplace builds reuse the root package instead of carrying a second copy under this component.

The hook command is:

bash
node "${PLUGIN_ROOT}/dist/cli.js" hook post-tool-use

The MCP command is:

bash
node ../../../../lsp-tools-mcp/dist/cli.js mcp

Local Development

bash
npm run bootstrap     # installs + builds the root packages/lsp-tools-mcp package
npm install
npm test
npm run typecheck
npm run check
npm pack --dry-run

The bootstrap script installs and builds the root lsp-tools-mcp package so @code-yeongyu/lsp-tools-mcp/dist/*.js is available for the codex-lsp build.

Smoke-test the hook:

bash
node dist/cli.js hook post-tool-use < test/fixtures/post-tool-use.json

Smoke-test the MCP server:

bash
printf '%s\n' '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node dist/cli.js mcp

Local Codex Installation

bash
bunx lazycodex install

The installer builds and copies the plugin into ~/.codex/plugins/cache/sisyphuslabs/omo/0.1.0, registers the sisyphuslabs marketplace from the lazycodex Git repository, and enables:

toml
[plugins."omo@sisyphuslabs"]
enabled = true

Branch Rules and Releases

  • main is protected by .github/branch-ruleset.json.
  • CI runs Node 20 and 22 on Ubuntu, macOS, and Windows.
  • Releases are GitHub Releases tagged as v<semver>.
  • Publishing runs from the publish workflow after a GitHub Release is published.

Privacy

This plugin runs locally. It starts configured language-server commands on your machine and does not call a network service by itself.

License

MIT.