Skip to content

code-yeongyu/codex-lsp

Repository files navigation

codex-lsp

ci license: MIT

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 here as a git submodule at packages/lsp-tools-mcp/.

  • 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

Case Result
apply_patch succeeds parses tool_input.command, extracts added/updated/moved files, and checks each with LSP error diagnostics
write / edit / multiedit succeeds checks path, filePath, or file_path aliases
diagnostics contain errors returns Codex PostToolUse blocking feedback and injects the same diagnostics as additional context so Codex fixes the file
no diagnostics emits no hook output
unsupported extension emits no hook output
missing configured language server surfaces 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:

.codex/lsp-client.json

User config:

~/.codex/lsp-client.json

Example:

{
	"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:./packages/lsp-tools-mcp, so marketplace builds must include submodule contents.

The hook command is:

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

The MCP command is:

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

Local Development

git submodule update --init --recursive
npm run bootstrap     # installs + builds the lsp-tools-mcp submodule
npm install
npm test
npm run typecheck
npm run check
npm pack --dry-run

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

Smoke-test the hook:

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

Smoke-test the MCP server:

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

Local Codex Installation

From the marketplace root containing this plugin:

codex plugin marketplace add /path/to/codex-plugins
node /path/to/codex-plugins/scripts/install-local.mjs /path/to/codex-plugins

If your local Codex build exposes plugin install commands, you can install from the UI or CLI instead. For older local builds, the marketplace installer builds and copies the plugin into ~/.codex/plugins/cache/<marketplace>/codex-lsp/0.2.0 and enables:

[plugins."codex-lsp@code-yeongyu-codex-plugins"]
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.

Related

About

Codex plugin that exposes Language Server Protocol diagnostics and MCP tools

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors