{
  "markdown": "# Auvik MCP Server\n\nMCP server for the Auvik network monitoring API. This server provides tools to interact with Auvik's network monitoring platform, allowing you to manage devices, networks, alerts, and more.\n\n## Features\n\n- **Multi-tenant support** - Works in both single-tenant and gateway modes\n- **Comprehensive API coverage** - 25+ tools covering all major Auvik API endpoints\n- **Transport flexibility** - Supports both HTTP and stdio transports\n- **Type-safe** - Built with TypeScript and Zod validation\n- **Docker ready** - Available as a containerized solution\n\n## Tools Available\n\n### Status and Navigation\n- `auvik_status` - Check server status and configuration\n- `auvik_navigate` - Get navigation links to Auvik UI and documentation\n\n### Tenants\n- `auvik_tenants_list` - List all accessible tenants\n- `auvik_tenants_get` - Get basic tenant information\n- `auvik_tenants_detail` - Get detailed tenant information\n\n### Devices\n- `auvik_devices_list` - List network devices\n- `auvik_devices_get` - Get basic device information\n- `auvik_devices_get_details` - Get detailed device information\n- `auvik_devices_get_warranty` - Get device warranty information\n- `auvik_devices_get_lifecycle` - Get device lifecycle information\n\n### Networks\n- `auvik_networks_list` - List discovered networks\n- `auvik_networks_get` - Get network information\n\n### Interfaces\n- `auvik_interfaces_list` - List network interfaces\n\n### Configurations\n- `auvik_configurations_list` - List device configurations\n- `auvik_configurations_get` - Get specific configuration\n\n### Entities\n- `auvik_entities_list_notes` - List entity notes\n- `auvik_entities_list_audits` - List entity audit logs\n\n### Alerts\n- `auvik_alerts_list` - List alert history. Scope to recent alerts with `filter_detectedTimeAfter`/`filter_detectedTimeBefore` (ISO 8601); filter by `filter_status`/`filter_severity`; paginate by cursor with `pageSize` + `pageAfter` (follow the returned `nextPageAfter`). `sort` is a best-effort passthrough.\n- `auvik_alerts_get` - Get specific alert\n- `auvik_alerts_dismiss` - Dismiss/acknowledge alert\n\n### Statistics\n- `auvik_statistics_device` - Get device performance metrics\n- `auvik_statistics_interface` - Get interface performance metrics\n- `auvik_statistics_service` - Get service performance metrics\n- `auvik_statistics_snmp_poller` - Get SNMP poller metrics\n\n### Billing\n- `auvik_billing_client_usage` - Get client billing usage\n- `auvik_billing_device_usage` - Get device billing usage\n\n### Raw\n- `auvik_raw_request` - Make a raw request to any Auvik endpoint (`method` GET/POST, `path`, optional `query`/`body`). Returns the unmodified JSON:API response. For endpoints or params the typed tools don't expose.\n\n## Installation\n\n### Environment Variables\n\n#### Single-tenant mode (stdio/direct):\n```bash\nAUVIK_USERNAME=your_auvik_username\nAUVIK_API_KEY=your_auvik_api_key\nAUVIK_REGION=us1  # Optional: us1, us2, us3, us4, us5, us6, lnx, eu1, eu2, au1, ca1\n```\n\n#### Gateway mode (HTTP):\nCredentials are provided via request headers:\n- `x-auvik-username`\n- `x-auvik-api-key`\n- `x-auvik-region` (optional)\n\n### Docker\n\n```bash\n# Pull from GitHub Container Registry\ndocker pull ghcr.io/wyre-ai/auvik-mcp:latest\n\n# Run with environment variables\ndocker run -d \\\n  -p 8080:8080 \\\n  -e AUVIK_USERNAME=your_username \\\n  -e AUVIK_API_KEY=your_api_key \\\n  -e AUVIK_REGION=us1 \\\n  ghcr.io/wyre-ai/auvik-mcp:latest\n```\n\n### Docker Compose\n\n```yaml\nversion: '3.8'\nservices:\n  auvik-mcp:\n    image: ghcr.io/wyre-ai/auvik-mcp:latest\n    ports:\n      - \"8080:8080\"\n    environment:\n      - AUVIK_USERNAME=your_username\n      - AUVIK_API_KEY=your_api_key\n      - AUVIK_REGION=us1\n```\n\n### Local Development\n\n```bash\ngit clone https://github.com/WYRE-AI/auvik-mcp.git\ncd auvik-mcp\nnpm install\nnpm run build\n\n# Run with stdio transport\nnpm start\n\n# Run with HTTP transport\nnpm run start:http\n```\n\n## Usage\n\n### With MCP Gateway\n\nThe server is designed to work with WYRE's MCP Gateway. The gateway handles authentication and routing:\n\n```typescript\n// Gateway automatically injects credentials via headers\nconst response = await fetch('http://gateway:8080/mcp', {\n  method: 'POST',\n  headers: {\n    'x-auvik-username': 'your_username',\n    'x-auvik-api-key': 'your_api_key',\n    'x-auvik-region': 'us1',\n    'content-type': 'application/json',\n  },\n  body: JSON.stringify({\n    jsonrpc: '2.0',\n    id: 1,\n    method: 'tools/call',\n    params: {\n      name: 'auvik_devices_list',\n      arguments: {}\n    }\n  })\n});\n```\n\n### Direct Usage (stdio)\n\n```bash\necho '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"tools/call\",\"params\":{\"name\":\"auvik_status\",\"arguments\":{}}}' | npm start\n```\n\n## API Regions\n\nAuvik operates in multiple regions. Set the appropriate region:\n\n- `us1` - US East (default)\n- `us2` - US West\n- `us3` - US Central\n- `us4` - US South\n- `us5` - United States (newer cluster)\n- `us6` - US East (Ohio)\n- `lnx` - US East (Ohio)\n- `eu1` - Europe West\n- `eu2` - Europe Central\n- `au1` - Australia\n- `ca1` - Canada\n\n## Error Handling\n\nThe server implements comprehensive error handling:\n\n- Invalid credentials return 401 errors\n- Missing resources return descriptive \"not found\" messages with `isError: true`\n- API rate limits and service errors are properly mapped\n- All responses include structured error information\n\n## Health Check\n\nThe server exposes a health endpoint at `/health` that always returns 200 OK. This endpoint does not require authentication and is suitable for container health checks.\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Run in development mode with file watching\nnpm run dev\n\n# Run tests\nnpm test\n\n# Type checking\nnpm run typecheck\n\n# Lint\nnpm run lint\n\n# Build\nnpm run build\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.\n\n## License\n\nLicensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.\n\n## Support\n\n- [GitHub Issues](https://github.com/WYRE-AI/auvik-mcp/issues)\n- [Auvik API Documentation](https://api.auvik.com/documentation)\n- [MCP Protocol Documentation](https://modelcontextprotocol.io/)",
  "bytes": 6083,
  "sha": "b294d85c090f1d7492dbaea5050e7f85f9abeee6fdbf8463b9d6056335dcb248",
  "repo_slug": "wyre-technology/auvik-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_wyre_technology_auvik_mcp_49c90ad6/readme"
}