documentation

Project conventions for written content, API responses, and Git commit messages. They require English documentation and define success and error response shapes and commit prefixes such as feat, fix, and docs.

In plain words
What is it for?
Use them when writing docs, comments, commit messages, API responses, or documenting new features and environment variables.
Why use it?
They keep documentation, API output, and commit history consistent across the project. This makes information easier for developers and tools to read.

Cursor rule for Cursor

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 rules/hatefsystems/search-engine-core/documentation
Clone the repo
git clone --depth 1 https://github.com/hatefsystems/search-engine-core

Made for: Cursor.

Per session 157 This file is loaded in full into every session.
When invoked 157 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00157 $0.00157
Opus 5 $0.00078 $0.00078
Sonnet 5 $0.00031 $0.00031
Haiku 4.5 $0.00016 $0.00016

Measured yesterday against content hash 68a2dc0d1f04, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation 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 yesterday.

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.

.cursor/rules/documentation.mdc · 24 lines

What it actually says

Documentation and Conventions

Language

All documentation, comments, commit messages, and docstrings must be in English. Exceptions: localization files, user-facing translated content, test data.

API Response Format

Success: {"success": true, "message": "...", "data": {...}} Error: {"success": false, "message": "...", "error": "ERROR_CODE"}

Git Commits

Format: type: description. Types: feat, fix, docs, refactor, test, perf, chore.

Docs Checklist

  • Write docs in English; update README and docs/api/ for new features; document new env vars.
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. yesterday First seen · 24 lines · 157 tokens per session scan A 68a2dc0d1f04

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository hatefsystems/search-engine-core (5 stars, last pushed 28d ago), licensed Apache-2.0. It adds 157 tokens to every session, about $0.0008 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.