Skip to content
DocumentationClient setupv1.2.1

Codex CLI

Registry-based setup for Codex CLI; confirm the active client configuration and project root.

Install and initialize Signalint in the repository you want Codex CLI to check. The MCP entry point is signalint-mcp; the registry emits --no-install. Install the package and verify that the client can resolve it from its launch environment; that flag is not a project-root selector.

Source scope: The paths and command shapes below describe Signalint 1.2.1’s registry/emitter, not an integration test of every client version. Confirm the active configuration path and accepted keys in your client’s own settings/docs before copying. A registry marker only helps init select a candidate; it does not prove that an editor is installed or reading that file.

The v1 JSON merger requires strict JSON (not comments/trailing commas) and replaces the selected Signalint entry, including custom env or arguments. Back up and review settings before accepting a write. TOML setup replaces its Signalint block rather than providing a full configuration parser.

Run npx signalint-mcp init to let Signalint detect the client and ask before updating its configuration. The v1 registry targets .codex/config.toml in the project root. Merge the example into the configuration your client actually uses, preserving unrelated servers.

[mcp_servers.signalint]
command = "npx"
args = ["--no-install", "signalint-mcp"]
startup_timeout_sec = 20
cwd = "/path/to/your-project"

Replace the example cwd with the absolute path to this repository. A fixed cwd belongs in a project-specific configuration, not a shared user entry.

The v1 registry also lists ~/.codex/config.toml as a user target. Omit a repository-specific cwd so one shared entry does not pin every workspace to the same project:

[mcp_servers.signalint]
command = "npx"
args = ["--no-install", "signalint-mcp"]
startup_timeout_sec = 20

For Windows, use the cmd /c wrapper shown in the project tab, without a fixed user-level cwd.

  1. Restart or reconnect the client’s MCP server connection.
  2. Call ping with {}. The text is pong; inspect structuredContent.projectRoot.
  3. Confirm that the root is this repository, then call check_project with {}.

If the local package cannot be found, check the client’s working directory and Node PATH. For a fixed project, an absolute node entry-point path can bypass package-manager shims; see troubleshooting.

Continue with the quickstart, or read multiple projects before sharing one configuration across repositories.