Skip to content

README.md

Latest commit

 

History

History
118 lines (86 loc) · 2.84 KB

README.md

File metadata and controls

118 lines (86 loc) · 2.84 KB

Garnet Platform MCP

MCP (Model Context Protocol) client for connecting Claude Desktop to the Garnet security platform.

Installation

You can use this client directly with npx (no installation required):

npx @garnet-org/platform-mcp

Or install globally:

npm install -g @garnet-org/platform-mcp

Configuration

1. Get your API token

Using garnetctl:

garnetctl config current-token

2. Configure Claude Desktop

Edit your Claude configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

Add this configuration:

{
  "mcpServers": {
    "garnet": {
      "command": "npx",
      "args": ["@garnet-org/platform-mcp"],
      "env": {
        "GARNET_API_URL": "https://api.garnet.ai/api/v1/mcp",
        "GARNET_API_TOKEN": "your-token-here"
      }
    }
  }
}

Or if installed globally:

{
  "mcpServers": {
    "garnet": {
      "command": "garnet-mcp",
      "env": {
        "GARNET_API_URL": "https://api.garnet.ai/api/v1/mcp",
        "GARNET_API_TOKEN": "your-token-here"
      }
    }
  }
}

3. Restart Claude Desktop

4. Verify the connection

In Claude, you should see Garnet tools available. Try asking:

  • "List recent security events"
  • "Show me security issues"
  • "List network policies"

Environment Variables

  • GARNET_API_URL: The Garnet API endpoint (default: http://localhost:8080/api/v1/mcp)
  • GARNET_API_TOKEN: Your project authentication token (required)

Available Tools

The MCP client provides access to these Garnet security tools:

  • garnetListEvents - List recent security events with filtering options
  • garnetGetEvent - Get detailed information about a specific event
  • garnetBlockEvent - Block network destination associated with an event
  • garnetListAgents - List security agents in the project
  • garnetListIssues - List security issues with filtering options
  • garnetGetIssue - Get detailed information about a specific issue
  • garnetBlockIssue - Block network destination associated with an issue
  • garnetListNetworkPolicies - List network policies for the project

Self-Hosted Instances

If you're running a self-hosted Garnet instance, update the GARNET_API_URL to point to your server:

"env": {
  "GARNET_API_URL": "https://your-garnet-instance.com/api/v1/mcp",
  "GARNET_API_TOKEN": "your-token-here"
}

Development

This client acts as a bridge between Claude's MCP protocol (stdio) and the Garnet HTTP API. It forwards JSON-RPC requests from Claude to the Garnet server and returns the responses.

Support

For issues and questions:

License

MIT