OpenObserve MCP服务器

OpenObserve社区版的MCP服务器,为本地MCP客户端提供REST API接口服务。

  • by alilxxey
  • Python
  • 本地部署
  • 16 星标
  • 更新于
在 GitHub 查看 alilxxey/openobserve-community-mcp

使用说明

Openbserve MCP

stdio 用于OpenObserve社区版的MCP服务器,仅使用常规REST API。

此软件包专为Claude和Codex等本地MCP客户设计。

它是什么:

  • stdio 仅
  • 仅限社区版
  • 只读
  • 仅限常规OpenObserve REST API
  • 没有本地人 /mcp 端点

服务器可以在没有活动Openbserve配置的情况下启动,因此托管的MCP平台可以启动它, 但每次工具调用仍然需要一个可访问的外部Openbserve实例,该实例通过以下方式配置 OO_BASE_URL 以及证书。

快速开始

1.创建配置文件

uvx --from openobserve-community-mcp openobserve-mcp init-config

这将在以下位置创建一个示例配置:

~/.config/openobserve-mcp/config.env

编辑它:

vim ~/.config/openobserve-mcp/config.env

例子:

OO_BASE_URL=https://openobserve.example.com
# Optional if the credentials have access to exactly one organization.
# OO_ORG_ID=default
OO_AUTH_MODE=basic
OO_USERNAME=your_username
OO_PASSWORD=your_password
OO_TIMEOUT_SECONDS=20
OO_VERIFY_SSL=true

2.添加到Claude

claude mcp add -s user openobserve-community -- uvx --from openobserve-community-mcp openobserve-mcp

3.将其添加到Codex

codex mcp add openobserve-community -- uvx --from openobserve-community-mcp openobserve-mcp

4.将其添加到OpenCode

OpenCode配置MCP服务器 mcp 在其配置文件中。根据官方文件, 您可以在全局配置中添加MCP服务器 ~/.config/opencode/opencode.json 或在a 项目级 opencode.json.

请参阅:

如果您使用创建了示例配置 openobserve-mcp init-config,您可以将OpenCode指向它:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "openobserve-community": {
      "type": "local",
      "command": ["uvx", "--from", "openobserve-community-mcp", "openobserve-mcp"],
      "enabled": true,
      "environment": {
        "OO_CONFIG_FILE": "/absolute/path/to/config.env"
      }
    }
  }
}

您还可以直接在OpenCode MCP配置中内联Openbserve设置:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "openobserve-community": {
      "type": "local",
      "command": ["uvx", "--from", "openobserve-community-mcp", "openobserve-mcp"],
      "enabled": true,
      "environment": {
        "OO_BASE_URL": "https://openobserve.example.com",
        "OO_AUTH_MODE": "basic",
        "OO_USERNAME": "your_username",
        "OO_PASSWORD": "your_password"
      }
    }
  }
}

OpenCode的MCP文档也支持可选 enabled, environment,以及 timeout 本地字段 如果你想调整启动行为,可以使用服务器。

Docker/Glama

此存储库还为基于Docker的MCP客户端和Glama部署发布了一个容器映像:

docker run --rm -i \
  -e OO_BASE_URL \
  -e OO_ORG_ID \
  -e OO_AUTH_MODE \
  -e OO_USERNAME \
  -e OO_PASSWORD \
  -e OO_TOKEN \
  -e OO_TIMEOUT_SECONDS \
  -e OO_VERIFY_SSL \
  ghcr.io/alilxxey/openobserve-community-mcp:latest

OO_ORG_ID 当凭据只能访问一个组织时,是可选的。 使用 OO_USERNAME 和 OO_PASSWORD 为了 basic 认证,或 OO_TOKEN 为了 bearer auth。 对于托管的MCP平台,容器可以在没有这些值的情况下启动,但工具调用将失败,直到 您可以配置一个真正的外部Openbserve实例。

配置

默认配置路径:

~/.config/openobserve-mcp/config.env

支持的设置:

  • OO_BASE_URL
  • OO_ORG_ID 可选的
  • OO_AUTH_MODE
  • OO_USERNAME 和 OO_PASSWORD 用于基本身份验证
  • OO_TOKEN 用于承载身份验证
  • OO_TIMEOUT_SECONDS
  • OO_VERIFY_SSL
  • OO_CONFIG_FILE 配置文件的可选显式路径

配置优先级:

  1. 明确的 OO_CONFIG_FILE
  2. ~/.config/openobserve-mcp/config.env
  3. 遗产 .env.local 在当前目录中
  4. 进程环境覆盖文件值

您还可以直接通过MCP客户端环境设置传递配置。

带内联env的Claude

claude mcp add -s user openobserve-community \
  -e OO_BASE_URL=https://openobserve.example.com \
  -e OO_AUTH_MODE=basic \
  -e OO_USERNAME=your_username \
  -e OO_PASSWORD=your_password \
  -- uvx --from openobserve-community-mcp openobserve-mcp

带内联env的Codex

codex mcp add openobserve-community \
  --env OO_BASE_URL=https://openobserve.example.com \
  --env OO_AUTH_MODE=basic \
  --env OO_USERNAME=your_username \
  --env OO_PASSWORD=your_password \
  -- uvx --from openobserve-community-mcp openobserve-mcp

带内联env的OpenCode

如果你更喜欢将所有内容保存在OpenCode配置中,而不是单独保存 config.env,使用:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "openobserve-community": {
      "type": "local",
      "command": ["uvx", "--from", "openobserve-community-mcp", "openobserve-mcp"],
      "enabled": true,
      "environment": {
        "OO_BASE_URL": "https://openobserve.example.com",
        "OO_AUTH_MODE": "basic",
        "OO_USERNAME": "your_username",
        "OO_PASSWORD": "your_password"
      }
    }
  }
}

官方OpenCode参考:

工具

  • list_streams
  • get_stream_schema
  • search_logs
  • search_around
  • search_values
  • list_dashboards
  • get_dashboard
  • get_latest_traces

可选本地安装

如果你更喜欢持久的本地二进制文件而不是 uvx:

uv tool install openobserve-community-mcp

这将安装 openobserve-mcp 命令进入用户级别 uv 工具目录。

使用全局安装添加到Claude

claude mcp add -s user openobserve-community -- openobserve-mcp

通过全局安装添加到Codex

codex mcp add openobserve-community -- openobserve-mcp

您也可以直接运行服务器:

openobserve-mcp

此模式可能需要 ~/.local/bin 出现在你的 PATH.

如果 openobserve-mcp 也未找到:

  • 添加 ~/.local/bin 给你的 PATH;或
  • 使用推荐的 uvx --from openobserve-community-mcp openobserve-mcp 而是启动模式。