Skip to content

Updated

Claude Code

Claude Code reads MCP servers from a .mcp.json file in your project root or you can register a server with the claude mcp add CLI command.

Current guided setup

Use the pinned direct-MCP configuration below while the matching native plugin listing awaits review and public readback. This Claude setup follows the plugin route, so the CLI does not provide a direct-MCP config-writing command for it; merge the entry manually and preserve your other settings. The client guide keeps plugin distribution, client discovery, authentication and runtime acceptance as separate checks.

Option A — .mcp.json (recommended for teams)

Create or open .mcp.json in your project root and add the following. Commit the file to share the configuration with your team; each developer runs the OAuth login locally.

Manual fallback: merge the following into .mcp.json. Recommended: run npx -y lyrashield@0.2.14 login --oauth once; the local MCP server reads the selected workspace credential from ~/.lyrashield/credentials.json. If you use an API key instead, set it in your private process environment before starting the client.

{
  "mcpServers": {
    "lyrashield": {
      "command": "npx",
      "args": [
        "-y",
        "@lyrashield/mcp@0.2.12"
      ],
      "env": {
        "LYRASHIELD_API_URL": "https://app.lyrashieldai.com"
      }
    }
  }
}
Manual setup: the pinned CLI package (lyrashield@0.2.14) has no matching installer contract for this integration. Use the configuration or client instructions above and verify the client loads it.

Important gotchas

  • The project `.mcp.json` is shared by convention with the team; never inline a literal API key into it.
  • For stdio, `claude mcp add <name> -- <command> [args...]`; for HTTP, `claude mcp add --transport http <name> <url>`.
  • Use `--scope user` for a global alternative to the shared project file.
OAuth first: Run npx -y lyrashield@0.2.14 login --oauth to select one workspace. API keys are the CI or non-OAuth-client fallback. A browser-confirmed remote OAuth delegation can run matching actions without repeated LyraShield approval.

Option B — Claude CLI

Run the documented stdio form in a terminal. The project scope creates a shareable MCP entry; each developer keeps their LyraShield credential in the local credential store.

claude mcp add --scope project --transport stdio lyrashield \
  -- npx -y @lyrashield/mcp@0.2.12

Public Agent Plugin listing pending

The portable Agent Plugin package @lyrashield/agent-plugin@0.1.31 is published; this client's public listing and authenticated runtime acceptance are still pending. Use direct MCP until those checks pass. Do not install from the marketplace's mutable preparation branch. Publication, plugin discovery, OAuth authentication and an authenticated read-only call are separate gates.

Verify the connection

After reloading Claude Code, open the MCP servers panel. You should see lyrashield listed as connected. Ask Claude: "What LyraShield tools are available?" to confirm the tools surface correctly.

Agent rules

Add a CLAUDE.md snippet to teach Claude when to run LyraShield checks automatically. See the Agent Rules Snippets page for ready-to-paste instructions.

Requirements: For local stdio, Node.js 24+ and a local OAuth login or workspace API key. Remote OAuth needs no local key. The @lyrashield/mcp package is published on npm, so npx -y @lyrashield/mcp@0.2.12 resolves directly.