How do I install OpenGrok MCP Server?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does OpenGrok MCP Server need an API key?

The publisher lists these environment variables: OPENGROK_BASE_URL, OPENGROK_USERNAME, OPENGROK_PASSWORD, OPENGROK_VERIFY_SSL, OPENGROK_CODE_MODE, OPENGROK_ENABLE_MEMORY_TOOLS, OPENGROK_DEFAULT_PROJECT, OPENGROK_CONTEXT_BUDGET, OPENGROK_API_VERSION, HTTP_PROXY, OPENGROK_RESPONSE_FORMAT_OVERRIDE, OPENGROK_MEMORY_BANK_DIR, OPENGROK_LOCAL_COMPILE_DB_PATHS, OPENGROK_ENABLE_ELICITATION, OPENGROK_ENABLE_SAMPLING, OPENGROK_SAMPLING_MODEL, OPENGROK_ENABLE_FILES_API, OPENGROK_ENABLE_OBSERVATION_MASKER, OPENGROK_OBSERVATION_MASKER_TURNS, OPENGROK_SAMPLING_MAX_TOKENS, OPENGROK_AUDIT_LOG_FILE, OPENGROK_RATELIMIT_RPM, OPENGROK_PER_TOOL_RATELIMIT, OPENGROK_TIMEOUT, OPENGROK_DEFAULT_MAX_RESULTS, OPENGROK_PASSWORD_FILE, OPENGROK_MAX_RESPONSE_BYTES, OPENGROK_SEARCH_AND_READ_CAP, OPENGROK_STRICT_SSRF, OPENGROK_JWT_ISSUER, OPENGROK_GRAMMAR_DIR.

What transport does OpenGrok MCP Server use?

OpenGrok MCP Server runs locally over stdio.

OpenGrok MCP Server

Q: When was OpenGrok MCP Server last checked?

Last checked 2026-10-16. MCP server bridging OpenGrok search engine with AI for instant context across massive codebases.

by io.github.IcyHot09

MCP server bridging OpenGrok search engine with AI for instant context across massive codebases.

接入你的智能体

添加此服务器

The publisher's own command. Not a PlugMCP endpoint.

Local command

npx -y [email protected]

Credentials from the publisher

OPENGROK_BASE_URL — OpenGrok server base URL (e.g. https://opengrok.example.com/source/)
OPENGROK_USERNAME — OpenGrok authentication username. Leave unset for anonymous access.
OPENGROK_PASSWORD — OpenGrok authentication password. Prefer storing via OS keychain using 'npx opengrok-mcp-server setup'.
OPENGROK_VERIFY_SSL — Verify TLS certificates. Set to false for self-signed or internal CA certs.
OPENGROK_CODE_MODE — Enable Code Mode: 2-tool sandbox interface with env.opengrok.* JavaScript API. Reduces AI token usage by ~90%.
OPENGROK_ENABLE_MEMORY_TOOLS — Register the 3 memory tools in Code Mode (memory status, read, update). Off = api + execute only.
OPENGROK_DEFAULT_PROJECT — Default project to scope all searches. Can be overridden per call.
OPENGROK_CONTEXT_BUDGET — Response size tier controlling token usage.
OPENGROK_API_VERSION — OpenGrok REST API version. Use v2 for call graph features (requires OpenGrok 1.12+).
HTTP_PROXY — HTTP/HTTPS proxy URL for all OpenGrok API requests (e.g. http://proxy.company.com:8080). Also set as HTTPS_PROXY.
OPENGROK_RESPONSE_FORMAT_OVERRIDE — Force a specific response format for all tools. Leave unset for per-tool auto-selection (recommended).
OPENGROK_MEMORY_BANK_DIR — Directory where the AI stores investigation notes (active-task.md, investigation-log.md). Defaults to ~/.config/opengrok-mcp/memory-bank/ or workspace-relative when set by the VS Code extension.
OPENGROK_LOCAL_COMPILE_DB_PATHS — Comma-separated paths to compile_commands.json for C/C++ compiler flag and include-path extraction. Leave unset for automatic workspace discovery.
OPENGROK_ENABLE_ELICITATION — Interactive AI Prompts — the AI pauses to ask questions during investigations (project selection, file disambiguation). Requires Claude Code v2.1.76+ or a client that supports MCP Elicitation.
OPENGROK_ENABLE_SAMPLING — AI Sampling — allow the server to request LLM completions for error explanations and summaries. Off by default to avoid consuming premium requests (e.g. GitHub Copilot).
OPENGROK_SAMPLING_MODEL — Model preference for MCP Sampling (used for error explanation and query reformulation).
OPENGROK_ENABLE_FILES_API — Files API Cache — avoids re-uploading unchanged investigation notes. Requires Files API support in the MCP client.
OPENGROK_ENABLE_OBSERVATION_MASKER — Observation Masker — prepend compact history summaries to opengrok_execute results after N turns. Disabled by default; has no benefit for clients that retain full context (Claude Code, Cursor).
OPENGROK_OBSERVATION_MASKER_TURNS — Number of most-recent opengrok_execute results to keep as full text before masking older ones. Default: 10.
OPENGROK_SAMPLING_MAX_TOKENS — Maximum tokens for AI sampling responses (error explanation, query reformulation). Range: 64–4096.
OPENGROK_AUDIT_LOG_FILE — Path to write structured audit events (CSV/JSON). Appends tool invocations, elicitation events, and errors. Leave unset to disable.
OPENGROK_RATELIMIT_RPM — Maximum requests per minute to the OpenGrok server. Default: 60.
OPENGROK_PER_TOOL_RATELIMIT — Per-tool rate limits in requests per minute, as comma-separated tool:rpm pairs (e.g. opengrok_execute:15,opengrok_search_code:30). Overrides OPENGROK_RATELIMIT_RPM for specific tools.
OPENGROK_TIMEOUT — HTTP request timeout in seconds for OpenGrok API calls. Increase for slow servers. Default: 30.
OPENGROK_DEFAULT_MAX_RESULTS — Default maximum number of results returned per search query. Default: 25.
OPENGROK_PASSWORD_FILE — Path to a file containing the OpenGrok password (file-mounted secret for containers). Takes precedence over the OS keychain when OPENGROK_PASSWORD is unset.
OPENGROK_MAX_RESPONSE_BYTES — Hard cap on response payload size in bytes. Overrides the context-budget default. Non-positive values are ignored.
OPENGROK_SEARCH_AND_READ_CAP — Cap for the search_and_read compound tool in bytes. Overrides the context-budget default (2–8 KB depending on tier). Non-positive values are ignored.
OPENGROK_STRICT_SSRF — When true, reject OPENGROK_BASE_URL values pointing at private/loopback IPs at startup. Default: false (warn only; per-request guards still apply).
OPENGROK_JWT_ISSUER — Expected JWT issuer (iss claim) for HTTP transport OAuth. When set, JWTs from other issuers are rejected.
OPENGROK_GRAMMAR_DIR — Directory containing tree-sitter WASM grammars. Overrides the bundled grammar lookup.

Provider

Claude Code

OPENGROK_BASE_URL=<value> OPENGROK_USERNAME=<value> OPENGROK_PASSWORD=<secret> OPENGROK_VERIFY_SSL=<value> OPENGROK_CODE_MODE=<value> OPENGROK_ENABLE_MEMORY_TOOLS=<value> OPENGROK_DEFAULT_PROJECT=<value> OPENGROK_CONTEXT_BUDGET=<value> OPENGROK_API_VERSION=<value> HTTP_PROXY=<value> OPENGROK_RESPONSE_FORMAT_OVERRIDE=<value> OPENGROK_MEMORY_BANK_DIR=<value> OPENGROK_LOCAL_COMPILE_DB_PATHS=<value> OPENGROK_ENABLE_ELICITATION=<value> OPENGROK_ENABLE_SAMPLING=<value> OPENGROK_SAMPLING_MODEL=<value> OPENGROK_ENABLE_FILES_API=<value> OPENGROK_ENABLE_OBSERVATION_MASKER=<value> OPENGROK_OBSERVATION_MASKER_TURNS=<value> OPENGROK_SAMPLING_MAX_TOKENS=<value> OPENGROK_AUDIT_LOG_FILE=<value> OPENGROK_RATELIMIT_RPM=<value> OPENGROK_PER_TOOL_RATELIMIT=<value> OPENGROK_TIMEOUT=<value> OPENGROK_DEFAULT_MAX_RESULTS=<value> OPENGROK_PASSWORD_FILE=<value> OPENGROK_MAX_RESPONSE_BYTES=<value> OPENGROK_SEARCH_AND_READ_CAP=<value> OPENGROK_STRICT_SSRF=<value> OPENGROK_JWT_ISSUER=<value> OPENGROK_GRAMMAR_DIR=<value> claude mcp add io.github.icyhot09-opengrok-mcp-server -- npx -y [email protected]

Run in a terminal.

Claude Desktop

{
  "mcpServers": {
    "io.github.icyhot09-opengrok-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "[email protected]"
      ],
      "env": {
        "OPENGROK_BASE_URL": "<value>",
        "OPENGROK_USERNAME": "<value>",
        "OPENGROK_PASSWORD": "<secret>",
        "OPENGROK_VERIFY_SSL": "<value>",
        "OPENGROK_CODE_MODE": "<value>",
        "OPENGROK_ENABLE_MEMORY_TOOLS": "<value>",
        "OPENGROK_DEFAULT_PROJECT": "<value>",
        "OPENGROK_CONTEXT_BUDGET": "<value>",
        "OPENGROK_API_VERSION": "<value>",
        "HTTP_PROXY": "<value>",
        "OPENGROK_RESPONSE_FORMAT_OVERRIDE": "<value>",
        "OPENGROK_MEMORY_BANK_DIR": "<value>",
        "OPENGROK_LOCAL_COMPILE_DB_PATHS": "<value>",
        "OPENGROK_ENABLE_ELICITATION": "<value>",
        "OPENGROK_ENABLE_SAMPLING": "<value>",
        "OPENGROK_SAMPLING_MODEL": "<value>",
        "OPENGROK_ENABLE_FILES_API": "<value>",
        "OPENGROK_ENABLE_OBSERVATION_MASKER": "<value>",
        "OPENGROK_OBSERVATION_MASKER_TURNS": "<value>",
        "OPENGROK_SAMPLING_MAX_TOKENS": "<value>",
        "OPENGROK_AUDIT_LOG_FILE": "<value>",
        "OPENGROK_RATELIMIT_RPM": "<value>",
        "OPENGROK_PER_TOOL_RATELIMIT": "<value>",
        "OPENGROK_TIMEOUT": "<value>",
        "OPENGROK_DEFAULT_MAX_RESULTS": "<value>",
        "OPENGROK_PASSWORD_FILE": "<value>",
        "OPENGROK_MAX_RESPONSE_BYTES": "<value>",
        "OPENGROK_SEARCH_AND_READ_CAP": "<value>",
        "OPENGROK_STRICT_SSRF": "<value>",
        "OPENGROK_JWT_ISSUER": "<value>",
        "OPENGROK_GRAMMAR_DIR": "<value>"
      }
    }
  }
}

claude_desktop_config.json

Step-by-step: add this in Claude

Remote URL or a command on your machine? How the two installs differ

在 PlugMCP 上运行

用我们的密钥与日志托管一份副本。

这是你新建的服务器，不是此条目的官方端点。若要用发布方的 URL 与凭证，请使用上方安装面板。

启动

Related MCP

Related skills

View all