documentation

A set of documentation and Markdown writing rules for Textrawl. Markdown is a plain-text format for creating structured documents.

In plain words
What is it for?
Structuring documentation folders, writing headings and code blocks, formatting tables and links, and using clear requirement terms such as MUST and SHOULD.
Why use it?
It keeps project documentation consistent, readable, and organised in the expected files and formats.

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/jeffgreendesign/textrawl/documentation
Clone the repo
git clone --depth 1 https://github.com/jeffgreendesign/textrawl

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 474 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 $0.00000 $0.00474
Opus 5 $0.00000 $0.00237
Sonnet 5 $0.00000 $0.00095
Haiku 4.5 $0.00000 $0.00047

Measured yesterday against content hash b1d05a66bd21, 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 · 104 lines

What it actually says

Documentation Standards

File Structure

docs/
├── README.md          # Main overview (in docs/, not root)
├── CLI.md             # CLI tool documentation
├── SECURITY.md        # Security and RLS guide
├── DESKTOP.md         # Desktop app documentation
└── DOCS-PLAYGROUND-FRAMEWORK.md  # Framework spec

Root-level files:

  • CLAUDE.md - AI coding assistant instructions
  • AGENTS.md - Agent conventions and tool guide
  • CONTRIBUTING.md - Contribution guidelines
  • llms.txt - AI sitemap

Markdown Conventions

Headings

Use ATX-style headings with blank lines:

# Title

## Section

### Subsection

Code Blocks

Always specify language for syntax highlighting:

```typescript
const example = 'code';

### Tables

Use consistent alignment:

```markdown
| Column 1 | Column 2 |
|----------|----------|
| Value 1  | Value 2  |

Links

Use reference-style for repeated links:

See the [CLI documentation][cli] for details.

[cli]: docs/CLI.md

RFC 2119 Language

Use precise language for requirements in tool documentation:

  • MUST / REQUIRED: Absolute requirement
  • SHOULD / RECOMMENDED: Strong recommendation
  • MAY / OPTIONAL: Truly optional

Example:

The query parameter MUST be provided. The tags parameter MAY be omitted.

Tool Documentation Template

### tool_name

Brief description of what the tool does.

**Parameters:**

- `param` (type, REQUIRED): Description
- `optionalParam` (type, OPTIONAL): Description, default: value

**Response:**

```json
{ "example": "response" }

Errors:

Error Cause Fix
Error name Why it happens How to fix
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 · 104 lines · 0 tokens per session scan A b1d05a66bd21

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository jeffgreendesign/textrawl (5 stars, last pushed 29d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 474 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-31.