opengrok-go-mcp: Instructions file for Codex

AGENTS.md

opengrok-go-mcp AGENTS.md is an instructions file for Codex, OpenCode from rokasklive/opengrok-go-mcp. It costs 1,791 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for opengrok-go-mcp, a Go server that lets AI assistants search indexed code, read source files, follow symbols, and provide source citations through OpenGrok.

In plain words
What is it for?
Use them when navigating or changing the server, checking its MCP tools and schemas, understanding OpenGrok searches, running evaluations, or reviewing the active feature plan.
Why use it?
They explain the project’s layout, supported search behavior, limitations, validation rules, and diagnostic settings. This helps an agent give answers grounded in the actual indexed source.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions subagents.

This is rokasklive/opengrok-go-mcp's own configuration. It tells Codex and OpenCode how to work on opengrok-go-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything opengrok-go-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to rokasklive/opengrok-go-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/rokasklive/opengrok-go-mcp/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/rokasklive/opengrok-go-mcp

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for opengrok-go-mcp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/rokasklive/opengrok-go-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/rokasklive/opengrok-go-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/rokasklive/opengrok-go-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/rokasklive/opengrok-go-mcp/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for opengrok-go-mcp AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/rokasklive/opengrok-go-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/rokasklive/opengrok-go-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,791 This file is loaded in full into every session.
When invoked 1,791 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01791 $0.01791
Opus 5 $0.00896 $0.00896
Sonnet 5 $0.00358 $0.00358
Haiku 4.5 $0.00179 $0.00179

Measured 8d ago against content hash 7c60c71a0e8d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

opengrok-go-mcp AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 153 lines

How it starts

The opening of the file, as written. The whole thing — 153 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agent Guide

Project Purpose

opengrok-go-mcp exposes OpenGrok through MCP so agents can search indexed code, read source files, follow symbols, and answer with source citations.

Active feature plan: specs/008-grounded-tool-transparency/plan.md — grounded, test-backed tool transparency: honest descriptions (text+ctags not AST; supported/unsupported Lucene syntax via help.jsp ground truth) driven by a machine-enforced claim⇔test registry, de-opaqued validation errors (structured ToolErrorBody + suggestion, not raw oneOf), OPENGROK_MCP_DIAGNOSTICS gating (default off), and removal of schema slimming (no surface hides field docs).

Repository Map

  • cmd/opengrok-go-mcp/: server entrypoint and startup capability probing
  • internal/config/: environment, flags, defaults, validation
  • internal/mcpserver/: MCP tools, schemas, pagination, warnings, memory (see internal/mcpserver/README.md for file layout)
  • evals/: stdio subprocess eval harness (contract checks + token economy benchmark)
  • internal/opengrok/: OpenGrok API and web/raw-file client
  • docs/: limitations, agent usage patterns, design notes
  • .specify/: Spec Kit constitution, templates, scripts, extension hooks

Core MCP Contract Rules

  • Treat tool names, input fields, output fields, warnings (warnings[] codes and legacy warning string), errors (error_code), pagination, cursor semantics, citations, resources, and environment variables as public contract.
  • Write tool names, descriptions, schemas, warnings, defaults, and examples for a cold agent seeing the server for the first time.
  • Keep behavior consistent across full, compact, and gateway surfaces unless a spec explicitly says otherwise.
  • Preserve citation.url for source-backed answers.
  • New or changed response-size, tool-call, or auto-fetch behavior needs limits, defaults, and warnings.
  • For the detailed field-by-field contract (inputs, outputs, errors, warnings, pagination, citations, truncation, capability gates, compatibility, experimental fields), see docs/tool-contracts.md.

Read the full file on GitHub · 153 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 153 lines · 1,791 tokens per session scan A 7c60c71a0e8d

Subscribe to this mod's changes

opengrok-go-mcp AGENTS.md is an instructions file published in the GitHub repository rokasklive/opengrok-go-mcp (7 stars, last pushed 22d ago), licensed Apache-2.0. It adds 1,791 tokens to every session, about $0.0090 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens