{"id":51813922,"url":"https://github.com/devinoldenburg/shannon-mcp","last_synced_at":"2026-07-21T22:05:07.354Z","repository":{"id":369907357,"uuid":"1213682135","full_name":"devinoldenburg/shannon-mcp","owner":"devinoldenburg","description":"Model Context Protocol server bringing Shannon Lite security to your AI agent","archived":false,"fork":false,"pushed_at":"2026-06-16T23:36:59.000Z","size":55,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-07T12:30:53.041Z","etag":null,"topics":["ai-agent","mcp","mcp-server","security","security-automation","shannon","shannon-ai","shannon-lite","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devinoldenburg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-17T16:39:26.000Z","updated_at":"2026-06-16T23:37:03.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/devinoldenburg/shannon-mcp","commit_stats":null,"previous_names":["devinoldenburg/shannon-mcp"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/devinoldenburg/shannon-mcp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinoldenburg%2Fshannon-mcp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinoldenburg%2Fshannon-mcp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinoldenburg%2Fshannon-mcp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinoldenburg%2Fshannon-mcp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devinoldenburg","download_url":"https://codeload.github.com/devinoldenburg/shannon-mcp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinoldenburg%2Fshannon-mcp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35738495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-21T02:00:06.728Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-agent","mcp","mcp-server","security","security-automation","shannon","shannon-ai","shannon-lite","typescript"],"created_at":"2026-07-21T22:05:06.127Z","updated_at":"2026-07-21T22:05:07.345Z","avatar_url":"https://github.com/devinoldenburg.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eShannon Lite MCP\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eModel Context Protocol server for end-to-end Shannon Lite security workflows\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/shannon-lite-mcp\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/shannon-lite-mcp\" alt=\"NPM Version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"MIT License\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/devinoldenburg/shannon-mcp/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://github.com/devinoldenburg/shannon-mcp/actions/workflows/ci.yml/badge.svg\" alt=\"CI\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://modelcontextprotocol.io/\"\u003e\u003cimg src=\"https://img.shields.io/badge/MCP-Compatible-8A2BE2\" alt=\"MCP Compatible\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis package enables AI assistants and applications to configure Shannon, start scans, monitor runtime, inspect workspaces, and read reports programmatically.\n\n## Features\n\n- Full Shannon Lite workflow support through MCP tools\n- Built-in config management for `~/.shannon/config.toml`\n- Scan orchestration (`start`, `status`, `workspaces`, logs, report reads)\n- Safe destructive operations with explicit confirmation tokens\n- Smart CLI execution (`shannon` binary or fallback to `npx @keygraph/shannon`)\n- TypeScript implementation with strict Zod validation\n\n## Setup\n\n### Prerequisites\n\n- Node.js 18+\n- Docker (daemon running)\n- Shannon CLI access (`shannon` in `PATH` or `npx` available)\n\n### MCP Configuration\n\nIf you are running this repo locally (unpublished package), build first:\n\n```bash\nnpm install\nnpm run build\n```\n\nThen use command `node` with args `[/absolute/path/to/shannon-mcp/dist/index.js]` in your MCP client configuration.\n\n#### For Claude Desktop\n\nAdd to your Claude Desktop configuration file (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):\n\n```json\n{\n  \"mcpServers\": {\n    \"shannon-lite\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"shannon-lite-mcp\"]\n    }\n  }\n}\n```\n\n#### For Cursor\n\nAdd the configuration to your Cursor settings:\n\n```json\n{\n  \"mcpServers\": {\n    \"shannon-lite\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"shannon-lite-mcp\"]\n    }\n  }\n}\n```\n\n#### For Windsurf\n\nAdd the configuration to your Windsurf settings:\n\n```json\n{\n  \"mcpServers\": {\n    \"shannon-lite\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"shannon-lite-mcp\"]\n    }\n  }\n}\n```\n\n#### For Warp\n\nAdd the following to your Warp session setup:\n\n```json\n{\n  \"shannon-lite\": {\n    \"command\": \"npx\",\n    \"args\": [\"-y\", \"shannon-lite-mcp\"],\n    \"working_directory\": null,\n    \"start_on_launch\": true\n  }\n}\n```\n\n#### For Other MCP Clients\n\nUse standard MCP server settings:\n\n- **Command**: `npx -y shannon-lite-mcp` or `node /path/to/shannon-mcp/dist/index.js`\n- **Transport**: stdio\n\n## Available MCP Tools\n\n- `shannon_health` - Check Docker/Node/CLI readiness, config, and workspace state\n- `shannon_config_set` - Write `~/.shannon/config.toml` for `anthropic`, `custom_base_url`, `bedrock`, `vertex`, or `router`\n- `shannon_config_get` - Read current config with secret masking\n- `shannon_start_scan` - Start a scan with `url`, `repo`, and optional `config`, `workspace`, `output`, `pipeline_testing`, `router`\n- `shannon_status` - Get Temporal + worker runtime status\n- `shannon_list_workspaces` - List known Shannon workspaces\n- `shannon_get_workspace` - Return detailed workspace/session metadata\n- `shannon_read_workflow_log` - Read workspace `workflow.log` (tail by default)\n- `shannon_read_report` - Read final report from workspace deliverables\n- `shannon_stop` - Stop Shannon runtime (clean mode requires confirmation token)\n- `shannon_uninstall` - Remove `~/.shannon` and stop runtime (requires confirmation token)\n\n## Safety Notice\n\nShannon Lite can run real security test flows. Use only on systems you are authorized to test.\n\nDestructive operations require exact confirmation tokens:\n\n- `shannon_stop` with `clean=true`: `I_UNDERSTAND_THIS_WILL_REMOVE_SHANNON_DATA`\n- `shannon_uninstall`: `DELETE_SHANNON_HOME_AND_STOP_SHANNON`\n\n## Usage Examples\n\n### Configure Anthropic API Key\n\n```javascript\nawait mcp.callTool(\"shannon_config_set\", {\n  provider: \"anthropic\",\n  auth_method: \"api_key\",\n  api_key: \"sk-ant-...\"\n});\n```\n\n### Start a Scan\n\n```javascript\nawait mcp.callTool(\"shannon_start_scan\", {\n  url: \"https://example.com\",\n  repo: \"/absolute/path/to/repo\",\n  workspace: \"q2-audit\"\n});\n```\n\n### Read Final Report\n\n```javascript\nawait mcp.callTool(\"shannon_read_report\", {\n  workspace: \"q2-audit\"\n});\n```\n\n### Clean Stop (destructive)\n\n```javascript\nawait mcp.callTool(\"shannon_stop\", {\n  clean: true,\n  confirm_destructive: \"I_UNDERSTAND_THIS_WILL_REMOVE_SHANNON_DATA\"\n});\n```\n\n## Development Setup\n\n### Prerequisites\n\n- Node.js 18+\n- npm\n\n### Local Development\n\n1. **Install dependencies**:\n\n   ```bash\n   npm install\n   ```\n\n2. **Build the project**:\n\n   ```bash\n   npm run build\n   ```\n\n3. **Run in development mode**:\n\n   ```bash\n   npm run dev\n   ```\n\n4. **Run tests**:\n\n   ```bash\n   npm run test:run\n   ```\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the `LICENSE` file for details.\n\n## Links\n\n- [Shannon (Keygraph)](https://github.com/KeygraphHQ/shannon)\n- [Model Context Protocol Specification](https://spec.modelcontextprotocol.io/)\n- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)\n\n## Support\n\n- Create an issue for bug reports or feature requests\n- Check existing issues before creating new ones\n- Include reproduction steps, environment info, and relevant logs\n\n---\n\nMade with care for the security engineering community.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevinoldenburg%2Fshannon-mcp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevinoldenburg%2Fshannon-mcp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevinoldenburg%2Fshannon-mcp/lists"}