Skip to content

Commit a084a58

Browse files
AmperAmper
committed
updated docs and blog posts
1 parent e7275d9 commit a084a58

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+3514
-1662
lines changed

‎README.md‎

Lines changed: 47 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# VictoriaLogs MCP Server
22

33
[![Latest Release](https://img.shields.io/github/v/release/VictoriaMetrics/mcp-victorialogs?sort=semver&label=&filter=!*-victorialogs&logo=github&labelColor=gray&color=gray&link=https%3A%2F%2Fgithub.com%2FVictoriaMetrics%2Fmcp-victorialogs%2Freleases%2Flatest)](https://github.com/VictoriaMetrics/mcp-victorialogs/releases)
4-
[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/VictoriaMetrics/mcp-victorialogs)](https://archestra.ai/mcp-catalog/victoriametrics__mcp-victorialogs)
5-
[![smithery badge](https://smithery.ai/badge/@VictoriaMetrics/mcp-victorialogs)](https://smithery.ai/server/@VictoriaMetrics/mcp-victorialogs)
64
![License](https://img.shields.io/github/license/VictoriaMetrics/mcp-victorialogs?labelColor=green&label=&link=https%3A%2F%2Fgithub.com%2FVictoriaMetrics%2Fmcp-victorialogs%2Fblob%2Fmain%2FLICENSE)
75
![Slack](https://img.shields.io/badge/Join-4A154B?logo=slack&link=https%3A%2F%2Fslack.victoriametrics.com)
86
![X](https://img.shields.io/twitter/follow/VictoriaMetrics?style=flat&label=Follow&color=black&logo=x&labelColor=black&link=https%3A%2F%2Fx.com%2FVictoriaMetrics)
@@ -120,47 +118,22 @@ For building binary from source code you can use the following approach:
120118
# after that you can use docker image mcp-victorialogs for running or pushing
121119
```
122120

123-
### Smithery
124-
125-
To install VictoriaLogs MCP Server for your client automatically via [Smithery](https://smithery.ai/server/@VictoriaMetrics/mcp-victorialogs), yo can use the following commands:
126-
127-
```bash
128-
# Get the list of supported MCP clients
129-
npx -y @smithery/cli list clients
130-
#Available clients:
131-
# claude
132-
# cline
133-
# windsurf
134-
# roocode
135-
# witsy
136-
# enconvo
137-
# cursor
138-
# vscode
139-
# vscode-insiders
140-
# boltai
141-
# amazon-bedrock
142-
143-
# Install VictoriaLogs MCP server for your client
144-
npx -y @smithery/cli install @VictoriaMetrics/mcp-victorialogs --client <YOUR-CLIENT-NAME>
145-
# and follow the instructions
146-
```
147-
148121
## Configuration
149122

150123
MCP Server for VictoriaLogs is configured via environment variables:
151124

152-
| Variable | Description | Required | Default | Allowed values |
153-
|----------------------------|---------------------------------------------------------|----------|------------------|------------------------|
154-
| `VL_INSTANCE_ENTRYPOINT` | URL to VictoriaLogs instance | Yes | - | - |
155-
| `VL_INSTANCE_BEARER_TOKEN` | Authentication token for VictoriaLogs API | No | - | - |
156-
| `VL_INSTANCE_HEADERS` | Custom HTTP headers to send with requests (comma-separated key=value pairs) | No | - | - |
157-
| `VL_DEFAULT_TENANT_ID` | Default tenant ID used when tenant is not specified in requests (format: `AccountID:ProjectID` or `AccountID`) | No | `0:0` | - |
158-
| `MCP_SERVER_MODE` | Server operation mode. See [Modes](#modes) for details. | No | `stdio` | `stdio`, `sse`, `http` |
159-
| `MCP_LISTEN_ADDR` | Address for SSE or HTTP server to listen on | No | `localhost:8081` | - |
160-
| `MCP_DISABLED_TOOLS` | Comma-separated list of tools to disable | No | - | - |
161-
| `MCP_HEARTBEAT_INTERVAL` | Defines the heartbeat interval for the streamable-http protocol. <br /> It means the MCP server will send a heartbeat to the client through the GET connection, <br /> to keep the connection alive from being closed by the network infrastructure (e.g. gateways) | No | `30s` | - |
162-
| `MCP_LOG_FORMAT` | Log output format | No | `text` | `text`, `json` |
163-
| `MCP_LOG_LEVEL` | Minimum log level | No | `info` | `debug`, `info`, `warn`, `error` |
125+
| Variable | Description | Required | Default | Allowed values |
126+
|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------|----------------------------------|
127+
| `VL_INSTANCE_ENTRYPOINT` | URL to VictoriaLogs instance | Yes | - | - |
128+
| `VL_INSTANCE_BEARER_TOKEN` | Authentication token for VictoriaLogs API | No | - | - |
129+
| `VL_INSTANCE_HEADERS` | Custom HTTP headers to send with requests (comma-separated key=value pairs) | No | - | - |
130+
| `VL_DEFAULT_TENANT_ID` | Default tenant ID used when tenant is not specified in requests (format: `AccountID:ProjectID` or `AccountID`) | No | `0:0` | - |
131+
| `MCP_SERVER_MODE` | Server operation mode. See [Modes](#modes) for details. | No | `stdio` | `stdio`, `sse`, `http` |
132+
| `MCP_LISTEN_ADDR` | Address for SSE or HTTP server to listen on | No | `localhost:8081` | - |
133+
| `MCP_DISABLED_TOOLS` | Comma-separated list of tools to disable | No | - | - |
134+
| `MCP_HEARTBEAT_INTERVAL` | Defines the heartbeat interval for the streamable-http protocol. <br /> It means the MCP server will send a heartbeat to the client through the GET connection, <br /> to keep the connection alive from being closed by the network infrastructure (e.g. gateways) | No | `30s` | - |
135+
| `MCP_LOG_FORMAT` | Log output format | No | `text` | `text`, `json` |
136+
| `MCP_LOG_LEVEL` | Minimum log level | No | `info` | `debug`, `info`, `warn`, `error` |
164137

165138
### Modes
166139

@@ -260,6 +233,41 @@ claude mcp add victorialogs -- /path/to/mcp-victorialogs \
260233

261234
See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp) for more info.
262235

236+
### Codex
237+
238+
Codex CLI and the IDE extension use the same MCP configuration file: `~/.codex/config.toml`
239+
(or `.codex/config.toml` in a trusted project).
240+
241+
Run the command:
242+
243+
```sh
244+
codex mcp add victorialogs \
245+
--env VL_INSTANCE_ENTRYPOINT=<YOUR_VL_INSTANCE> \
246+
--env VL_INSTANCE_BEARER_TOKEN=<YOUR_VL_BEARER_TOKEN> \
247+
--env VL_INSTANCE_HEADERS="<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>" \
248+
-- /path/to/mcp-victorialogs
249+
```
250+
251+
Or add the following to your Codex `~/.codex/config.toml` file:
252+
253+
```toml
254+
[mcp_servers.victorialogs]
255+
command = "/path/to/mcp-victorialogs"
256+
257+
[mcp_servers.victorialogs.env]
258+
VL_INSTANCE_ENTRYPOINT = "<YOUR_VL_INSTANCE>"
259+
VL_INSTANCE_BEARER_TOKEN = "<YOUR_VL_BEARER_TOKEN>"
260+
VL_INSTANCE_HEADERS = "<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"
261+
```
262+
263+
If you run the server in Streamable HTTP mode, you can register it with:
264+
265+
```sh
266+
codex mcp add victorialogs --url http://localhost:8081/mcp
267+
```
268+
269+
See [Codex MCP docs](https://developers.openai.com/codex/mcp) for more info.
270+
263271
### Visual Studio Code
264272

265273
Add this to your VS Code MCP config file:

‎cmd/mcp-victorialogs/resources/vm/docs/victorialogs/Articles.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ menu:
77
identifier: "victorialogs-articles"
88
weight: 70
99
tags: []
10+
aliases:
11+
- /VictoriaLogs/Articles.html
1012
---
1113

1214
## Third-party articles and slides
@@ -30,6 +32,7 @@ Kubernetes Deployment and Production:
3032

3133
Integration and Data Collection:
3234

35+
* [GDPR-compliant website analytics with nginx, VictoriaLogs and Grafana](https://ayedo.de/posts/dsgvo-konforme-website-analytics-mit-nginx-victorialogs-und-grafana/)
3336
* [Vector.dev: introduction, AWS S3 logs, and integration with VictoriaLogs](https://itnext.io/vector-dev-introduction-aws-s3-logs-and-integration-with-victorialogs-d3585d7d9218)
3437
* [Using Vector and VictoriaLogs for Collect Switch Syslog](https://blog.vitalvas.com/post/2024/12/02/using-vector-and-victorialogs-for-collect-switch-syslog/)
3538
* [How to Extend Percona Monitoring and Management to Add Logging Functionality](https://www.percona.com/blog/how-to-extend-percona-monitoring-and-management-to-add-logging-functionality/)

0 commit comments

Comments
 (0)