Skip to content
LyraShield AIOpen beta

Updated

GitHub Copilot (Agent Plugin)

GitHub Copilot supports the open Agent Plugins v1.0.0 standard (agent-plugins.org). The LyraShield Agent Plugin bundles the MCP server and a security skill into a single installable package, so Copilot gets both the tools and the guidance for when to run them in one step — no hand-edited config required.

Install with the CLI (fastest)

Run npx lyrashield login --oauth first to select one workspace and save the OAuth credential to ~/.lyrashield/credentials.json. Then install the plugin:

npx lyrashield login --oauth
npx lyrashield install github-copilot

The plugin is installed to ~/.copilot/plugins/lyrashield. GitHub Copilot CLI scans each plugin directory for a plugin.json manifest at the root. Add --dry-run first to preview the change with no write, or run npx lyrashield doctor afterward to confirm it's configured correctly.

No credential in committed files: After npx lyrashield login --oauth, the plugin's MCP server reads credentials from ~/.lyrashield/credentials.json (or theLYRASHIELD_API_KEY environment variable). Nothing with a key needs to be committed.

What the plugin includes

  • MCP server: the full LyraShield tool surface (scan triggers, finding inspection, report creation) via stdio transport.
  • Security skill: guidance for when to run LyraShield checks during coding sessions.
  • Rules file: writes .github/copilot-instructions.md with LyraShield usage guidance.

Verify the connection

Run npx lyrashield doctor to confirm the plugin is installed and credentials are present. Then ask Copilot: "What LyraShield tools do you have access to?" to confirm the server is connected.

Requirements: Node.js 20+ and a LyraShield workspace OAuth login. Run npx lyrashield login --oauth before installing so the MCP stdio server can read credentials.