MCP server overview
What is Cribl MCP Server? Cribl MCP Server is a Model Context Protocol (MCP) server that exposes Cribl API operations as discoverable/invokable tools for AI clients. It lets AI assistants (via MCP clients) inspect and operate on a Cribl Stream deployment (list sources, read/set pipeline configs, restart worker groups, query metrics, etc.).
How to use the project?
- Requirements: Node.js v16+ and internet access to fetch the package.
- Quick run via npx: set required environment variables (e.g. CRIBL_BASE_URL, CRIBL_AUTH_TYPE, CRIBL_CLIENT_ID, CRIBL_CLIENT_SECRET) and run: CRIBL_BASE_URL=https://your.cribl.cloud.instance CRIBL_AUTH_TYPE=cloud CRIBL_CLIENT_ID=abc123 CRIBL_CLIENT_SECRET=secret npx @pebbletek/cribl-mcp
- Local development: git clone https://github.com/pebbletek/cribl-mcp.git, npm install, copy .env.example to .env and populate, then run/build per docs/usage.md
- Configure your MCP client (examples and JSON for clients provided in docs/usage.md) to connect and allow the AI access to tools.
Key features
- Exposes Cribl Stream operations as MCP tools (discoverable by AI clients).
- Tools include listing worker groups/fleets, getting/setting pipeline configs, retrieving source configs, restarting worker groups, and querying system metrics with filters.
- Supports multiple authentication modes (see docs/configuration.md) and environment-variable configuration.
- Can be run instantly via npx or installed for local development.
- Detailed reference documentation for tool parameters, outputs, and future tools in docs/overview.md.
Use cases
- Inspecting what data sources and pipelines are configured in a Cribl deployment via natural language queries.
- Making configuration changes to pipelines (e.g., change filters, enable/disable functions) and applying them programmatically.
- Restarting worker groups after config changes through an automated workflow.
- Querying system metrics to support troubleshooting and capacity planning.
- Integrating Cribl operational tasks into AI-assisted runbooks or chatops flows.
FAQ
-
How do I run it quickly without installing?
Use npx with required env vars (CRIBL_BASE_URL and auth details). See docs/usage.md for examples. -
What Node version is required?
Node 16 or later is recommended. -
What authentication modes are supported?
Multiple modes are described in docs/configuration.md; you must provide appropriate credentials (e.g., cloud client id/secret) via environment variables. -
Will changes made via the MCP server affect production?
Yes — the server invokes the Cribl API to change configs and restart worker groups. Ensure you use credentials with appropriate permissions and test changes in non-production environments first. -
Where can I find detailed tool docs and examples?
See the repo docs/: README.md, docs/usage.md, docs/configuration.md, and docs/overview.md for usage, config, and detailed tool references. -
What’s the license?
MIT.