OpenGrok MCP Server
MCP server bridging OpenGrok search engine with AI for instant context across massive…
- Pricing
- Open source
- Runs
- Locally
- Version
- 9.6.0
- Listing updated
- 6 days ago
About OpenGrok MCP Server
OpenGrok MCP Server is an open-source MCP server. It runs locally on your machine and is started by your AI client.
MCP server bridging OpenGrok search engine with AI for instant context across massive codebases.
Install
Run in a terminal
claude mcp add opengrok-mcp-server --env OPENGROK_BASE_URL='<OPENGROK_BASE_URL>' --env OPENGROK_PASSWORD='<OPENGROK_PASSWORD>' -- npx -y opengrok-mcp-serverAdd to claude_desktop_config.json
{
"mcpServers": {
"opengrok-mcp-server": {
"command": "npx",
"args": [
"-y",
"opengrok-mcp-server"
],
"env": {
"OPENGROK_BASE_URL": "<OPENGROK_BASE_URL>",
"OPENGROK_PASSWORD": "<OPENGROK_PASSWORD>"
}
}
}
}Add to ~/.cursor/mcp.json
{
"mcpServers": {
"opengrok-mcp-server": {
"command": "npx",
"args": [
"-y",
"opengrok-mcp-server"
],
"env": {
"OPENGROK_BASE_URL": "<OPENGROK_BASE_URL>",
"OPENGROK_PASSWORD": "<OPENGROK_PASSWORD>"
}
}
}
}Add to .vscode/mcp.json
{
"servers": {
"opengrok-mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"opengrok-mcp-server"
],
"env": {
"OPENGROK_BASE_URL": "<OPENGROK_BASE_URL>",
"OPENGROK_PASSWORD": "<OPENGROK_PASSWORD>"
}
}
}
}Add to ~/.codeium/windsurf/mcp_config.json
{
"mcpServers": {
"opengrok-mcp-server": {
"command": "npx",
"args": [
"-y",
"opengrok-mcp-server"
],
"env": {
"OPENGROK_BASE_URL": "<OPENGROK_BASE_URL>",
"OPENGROK_PASSWORD": "<OPENGROK_PASSWORD>"
}
}
}
}Add to your client's MCP settings (most use this shape)
{
"mcpServers": {
"opengrok-mcp-server": {
"command": "npx",
"args": [
"-y",
"opengrok-mcp-server"
],
"env": {
"OPENGROK_BASE_URL": "<OPENGROK_BASE_URL>",
"OPENGROK_PASSWORD": "<OPENGROK_PASSWORD>"
}
}
}
}Using several servers? Build one config file with the MCP config generator.
Configuration
OPENGROK_BASE_URLOpenGrok server base URL (e.g. https://opengrok.example.com/source/)RequiredOPENGROK_USERNAMEOpenGrok authentication username. Leave unset for anonymous access.OPENGROK_PASSWORDOpenGrok authentication password. Prefer storing via OS keychain using 'npx opengrok-mcp-server setup'.OPENGROK_VERIFY_SSLVerify TLS certificates. Set to false for self-signed or internal CA certs.OPENGROK_CODE_MODEEnable Code Mode: 2-tool sandbox interface with env.opengrok.* JavaScript API. Reduces AI token usage by ~90%.OPENGROK_ENABLE_MEMORY_TOOLSRegister the 3 memory tools in Code Mode (memory status, read, update). Off = api + execute only.OPENGROK_DEFAULT_PROJECTDefault project to scope all searches. Can be overridden per call.OPENGROK_CONTEXT_BUDGETResponse size tier controlling token usage.OPENGROK_API_VERSIONOpenGrok REST API version. Use v2 for call graph features (requires OpenGrok 1.12+).HTTP_PROXYHTTP/HTTPS proxy URL for all OpenGrok API requests (e.g. http://proxy.company.com:8080). Also set as HTTPS_PROXY.OPENGROK_RESPONSE_FORMAT_OVERRIDEForce a specific response format for all tools. Leave unset for per-tool auto-selection (recommended).OPENGROK_MEMORY_BANK_DIRDirectory 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_PATHSComma-separated paths to compile_commands.json for C/C++ compiler flag and include-path extraction. Leave unset for automatic workspace discovery.OPENGROK_ENABLE_ELICITATIONInteractive 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_SAMPLINGAI 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_MODELModel preference for MCP Sampling (used for error explanation and query reformulation).OPENGROK_ENABLE_FILES_APIFiles API Cache — avoids re-uploading unchanged investigation notes. Requires Files API support in the MCP client.OPENGROK_ENABLE_OBSERVATION_MASKERObservation 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_TURNSNumber of most-recent opengrok_execute results to keep as full text before masking older ones. Default: 10.OPENGROK_SAMPLING_MAX_TOKENSMaximum tokens for AI sampling responses (error explanation, query reformulation). Range: 64–4096.OPENGROK_AUDIT_LOG_FILEPath to write structured audit events (CSV/JSON). Appends tool invocations, elicitation events, and errors. Leave unset to disable.OPENGROK_RATELIMIT_RPMMaximum requests per minute to the OpenGrok server. Default: 60.OPENGROK_PER_TOOL_RATELIMITPer-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_TIMEOUTHTTP request timeout in seconds for OpenGrok API calls. Increase for slow servers. Default: 30.OPENGROK_DEFAULT_MAX_RESULTSDefault maximum number of results returned per search query. Default: 25.OPENGROK_PASSWORD_FILEPath 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_BYTESHard cap on response payload size in bytes. Overrides the context-budget default. Non-positive values are ignored.OPENGROK_SEARCH_AND_READ_CAPCap 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_SSRFWhen true, reject OPENGROK_BASE_URL values pointing at private/loopback IPs at startup. Default: false (warn only; per-request guards still apply).OPENGROK_JWT_ISSUERExpected JWT issuer (iss claim) for HTTP transport OAuth. When set, JWTs from other issuers are rejected.OPENGROK_GRAMMAR_DIRDirectory containing tree-sitter WASM grammars. Overrides the bundled grammar lookup.
Pricing
Open source
OpenGrok MCP Server FAQ
Is OpenGrok MCP Server free?
Yes. OpenGrok MCP Server is open source, so you can use and self-host it for free.
How do I add OpenGrok MCP Server to Claude Code?
Run this command in your terminal: claude mcp add opengrok-mcp-server --env OPENGROK_BASE_URL='<OPENGROK_BASE_URL>' --env OPENGROK_PASSWORD='<OPENGROK_PASSWORD>' -- npx -y opengrok-mcp-server
Where this comes from
- Description: from the official MCP Registry entry.
- Install steps: from the official MCP Registry entry.