docs-examples-guidelines

docs-examples-guidelines is a cursor rule for Cursor from armanayvazyan/allure-testops-mcp. It costs 0 tokens per session (115 once invoked), scanned A, original, MIT.

A set of rules for keeping documentation and example code accurate, consistent, and safe. It applies when changing a tool and its related guides or examples.

In plain words
What is it for?
Use it when updating tool behavior, README files, command examples, or files under docs/usages/examples/. It helps check that examples match package.json scripts and the tool’s current capabilities.
Why use it?
It prevents documentation from drifting away from the actual software and reduces the risk of publishing private tokens, URLs, or project details. It also keeps command examples ready to copy and use.

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/armanayvazyan/allure-testops-mcp/docs-examples-guidelines
Clone the repo
git clone --depth 1 https://github.com/armanayvazyan/allure-testops-mcp

Made for: Cursor.

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 docs-examples-guidelines

README.md
[![agentmods](https://agentmods.dev/badge/rules/armanayvazyan/allure-testops-mcp/docs-examples-guidelines.svg)](https://agentmods.dev/rules/armanayvazyan/allure-testops-mcp/docs-examples-guidelines)
Your own site
<a href="https://agentmods.dev/rules/armanayvazyan/allure-testops-mcp/docs-examples-guidelines"><img src="https://agentmods.dev/badge/rules/armanayvazyan/allure-testops-mcp/docs-examples-guidelines.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 115 The whole file, excluding the scripts and references it only reads on demand.
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.1 $0.00000 $0.00115
Opus 5 $0.00000 $0.00057
Sonnet 5 $0.00000 $0.00023
Haiku 4.5 $0.00000 $0.00012

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

Security

Grade A, and why

docs-examples-guidelines 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.

.cursor/rules/docs-examples-guidelines.mdc · 14 lines

What it actually says

Docs and Examples Guidelines

  • Keep command snippets copy-paste ready and consistent with package.json scripts.
  • When changing tool behavior, update matching files in docs/usages/examples/ in the same change.
  • Do not include real tokens, private URLs, or sensitive project identifiers in docs.
  • Prefer short, task-oriented examples with expected input context.
  • Keep README sections aligned with actual capabilities and current tool coverage.
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 · 14 lines · 0 tokens per session scan A 65c8c1215001

Subscribe to this mod's changes

docs-examples-guidelines is a cursor rule published in the GitHub repository armanayvazyan/allure-testops-mcp (20 stars, last pushed 3d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 115 tokens. 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-30.