sumi-docs AGENTS.md

sumi-docs AGENTS.md is an instructions file for Codex, OpenCode from starSumi/sumi-docs. It costs 877 tokens per session, scanned A, a copy of Sumi-Docs-MCP AGENTS.md, MIT.

Repository instructions for an AI coding agent working on the Sumi Docs workspace. They define the workspace’s product boundaries, package ownership, documentation rules, and how desired configuration is kept separate from live status.

In plain words
What is it for?
Use them when changing the Sumi Docs MCP server, Astro/Starlight website, content schemas, documentation, or project-specific agent workflows.
Why use it?
They reduce confusion about which package owns a change and prevent unsupported releases, deployments, or edits to unrelated repositories. They also provide rules for keeping configuration and runtime state from being mixed together.

Instructions file for CodexOpenCode

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

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/starsumi/sumi-docs/agents-md
Clone the repo
git clone --depth 1 https://github.com/starSumi/sumi-docs

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 sumi-docs AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/starsumi/sumi-docs/agents-md.svg)](https://agentmods.dev/instructions/starsumi/sumi-docs/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/starsumi/sumi-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/starsumi/sumi-docs/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 877 This file is loaded in full into every session.
When invoked 877 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin 86% copy Near-identical to another mod 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.00877 $0.00877
Opus 5 $0.00439 $0.00439
Sonnet 5 $0.00175 $0.00175
Haiku 4.5 $0.00088 $0.00088

Measured 5d ago against content hash 0c3f89af1c4d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

sumi-docs 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 5d 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.

Origin

This is a copy

86% identical to Sumi-Docs-MCP AGENTS.md — 14 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md · 87 lines

How it starts

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

Sumi Docs Workspace Instructions

Product contract

This workspace owns the Sumi Docs product. It contains a read-only MCP server, an Astro/Starlight website, and a versioned corpus contract. Source visibility does not authorize a tag, package, deployment, binary release, or archival of predecessor repositories.

Ownership

  • packages/mcp/: headless, stateless, read-only MCP data plane.
  • apps/web/: trusted content rendering and corpus publication.
  • packages/corpus-contract/: pure schemas, canonicalization, fixtures, and conformance helpers. No transport, filesystem, Astro, or parser behavior.
  • docs/: reviewed product documentation and default self-hosted corpus.
  • .agents/skills/: reviewed, repository-scoped usage and contribution workflows. Cross-repository maintainer policy remains user-scoped.
  • .codex/, .mcp.json, .vscode/: thin project MCP adapters only.

Nested AGENTS.md files continue to govern package-specific security and validation. The root contract wins for workspace topology and cross-package commands.

Reconciliation model

  • For any mutable orchestration resource, keep versioned desired spec separate from controller-owned status. Machine-readable conditions bind observedGeneration to the generation actually observed and record type, status, reason, and immutable evidence. Stale or incomplete evidence is Unknown, never success.
  • Automation follows an observe-diff-reconcile loop. Reconciliation is idempotent, cancellation-aware, and restartable. Each mutable resource has one logical writer protected by a lease and monotonically increasing fencing token. Promotion uses compare-and-set against the expected generation or revision; conflicts and unavailable preconditions fail closed.
  • apps/web owns staging, sealing, atomic promotion, and rollback of complete publication artifacts. Any future controller owns leases, events, retries, checkpoints, and cleanup outside the repository. Skills route intent and procedure only; packages/mcp remains a stateless, read-only data plane.
  • Preserve the last verified artifact when reconciliation fails, and treat rollback as an explicit, evidence-backed generation transition. Do not add a generic orchestration API, distributed state store, scheduler, or extension framework without a measured workload and an accepted decision.

Read the full file on GitHub · 87 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. 5d ago First seen · 87 lines · 877 tokens per session scan A 0c3f89af1c4d

Subscribe to this mod's changes

sumi-docs AGENTS.md is an instructions file published in the GitHub repository starSumi/sumi-docs (1 stars, last pushed 3d ago), licensed MIT. It adds 877 tokens to every session, about $0.0044 per session on Opus 5. A static security scan graded it A with 0 findings. It is 86% identical to Sumi-Docs-MCP AGENTS.md, differing in 14 lines, and is treated as a copy.

Related

Other instructions, from other repositories