Claude Code

Install and initialize Signalint in the repository you want Claude Code 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.

Project setup

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

macOS / Linux

{
  "mcpServers": {
    "signalint": {
      "command": "npx",
      "args": [
        "--no-install",
        "signalint-mcp"
      ],
      "cwd": "/path/to/your-project"
    }
  }
}

Windows

{
  "mcpServers": {
    "signalint": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "--no-install",
        "signalint-mcp"
      ],
      "cwd": "C:\\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.

User setup

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

{
  "mcpServers": {
    "signalint": {
      "command": "npx",
      "args": [
        "--no-install",
        "signalint-mcp"
      ]
    }
  }
}

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

Verify the connection

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.