Skip to content

add pinned tools for mcp #535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hengfeiyang merged 2 commits into from
Aug 11, 2026
Merged

add pinned tools for mcp #535

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afa8370
fix: mcp is open source now
hengfeiyang Aug 11, 2026
c16f68f
add pinned tools for mcp
hengfeiyang Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions docs/integration/ai/mcp/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,8 @@ You can connect your AI agents and IDEs to your OpenObserve instance to query lo
- **Agentic operations** like alert creation as part of CI/CD pipelines
- **AI-assisted troubleshooting** where an agent can pull stream data, correlate traces, and suggest root causes

:::note[Enterprise only]
MCP is supported in the Enterprise edition of OpenObserve.
:::

## Prerequisites

Set the following environment variables on your OpenObserve instance:

```bash
O2_TOOL_API_URL="http://localhost:5080"
O2_AI_ENABLED="true"
```

:::note[About `O2_TOOL_API_URL`]
`O2_TOOL_API_URL` is the address OpenObserve uses to call its own REST API internally. `http://localhost:5080` is correct for a local process. For containerized or remote deployments set it to the address at which the OpenObserve API is reachable from within the same environment (e.g. the service name in Docker Compose).
:::

Your MCP endpoint follows the pattern:

```
Expand Down Expand Up @@ -190,9 +175,13 @@ This pattern works with [OpenAI's Responses API](https://platform.openai.com/doc

## Available tools

When connected, your MCP client will see the following tools. Tool names are prefixed with your server name (e.g. `mcp__openobserve__StreamList`).
OpenObserve includes the following tools. Tool names are prefixed with your server name (e.g. `mcp__openobserve__StreamList`).

:::note[Tools are discovered on demand]
The catalog below shows all tools built into OpenObserve, but it is not sent to your MCP client all at once. By default, `tools/list` exposes `tool_search`, `tools_call`, and six frequently used pinned tools: `GetIncident`, `PrometheusRangeQuery`, `SearchSQL`, `StreamList`, `StreamSchema`, and `GetLatestTraces`. The agent uses `tool_search` to discover additional tools as needed, then runs them through `tools_call`. This keeps the initial tool list and model context small.
:::

**Legend:** `pinned` = visible at the top of tool listings · ⚠️ = destructive (modifies or deletes data)
**Legend:** `pinned` = exposed directly in the initial `tools/list` response (no search required) · ⚠️ = destructive (modifies or deletes data)

:::accordion[Alerts (28 tools)]

Expand Down Expand Up @@ -468,7 +457,6 @@ This is useful for keeping production data isolated from development queries, or
:::accordion[Connection fails / 404]

- Confirm the endpoint path includes `/api/{org_id}/mcp`
- Confirm `O2_AI_ENABLED=true` is set on the server
- Test the base URL with `curl` to verify network reachability
:::

Expand Down
Loading