readme

readme is a cursor rule for Cursor from tantodefi/xmtpauth. It costs 0 tokens per session (290 once invoked), scanned A, original, MIT.

A project rule describing the expected README content for an XMTP agent, including setup, requirements, configuration, and example commands.

In plain words
What is it for?
Use it when writing or checking README documentation for the XMTP example, including Node.js, Yarn, Docker, wallet keys, encryption keys, and environment settings.
Why use it?
It gives contributors a consistent way to explain how to install, configure, and run the agent.

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/tantodefi/xmtpauth/readme
Clone the repo
git clone --depth 1 https://github.com/tantodefi/xmtpauth

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 readme

README.md
[![agentmods](https://agentmods.dev/badge/rules/tantodefi/xmtpauth/readme.svg)](https://agentmods.dev/rules/tantodefi/xmtpauth/readme)
Your own site
<a href="https://agentmods.dev/rules/tantodefi/xmtpauth/readme"><img src="https://agentmods.dev/badge/rules/tantodefi/xmtpauth/readme.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 290 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.00290
Opus 5 $0.00000 $0.00145
Sonnet 5 $0.00000 $0.00058
Haiku 4.5 $0.00000 $0.00029

Measured 3d ago against content hash aa7b96d7b645, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

readme 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 3d 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/readme.mdc · 58 lines

What it actually says

Readme example format for new agents

GM agent

This agent replies gm

Getting started

[!TIP] See XMTP's cursor rules for vibe coding agents and best practices.

Requirements

  • Node.js v20 or higher
  • Yarn v4 or higher
  • Docker (optional, for local network)

Environment variables

To run your XMTP agent, you must create a .env file with the following variables:

WALLET_KEY= # the private key of the wallet
ENCRYPTION_KEY= # encryption key for the local database
XMTP_ENV=dev # local, dev, production

You can generate random xmtp keys with the following command:

yarn gen:keys

[!WARNING] Running the gen:keys command will append keys to your existing .env file.

Run the agent

# git clone repo
git clone https://github.com/ephemeraHQ/xmtp-agent-examples.git
# go to the folder
cd xmtp-agent-examples
cd examples/xmtp-gm
# install packages
yarn
# generate random xmtp keys (optional)
yarn gen:keys
# run the example
yarn dev
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. 3d ago First seen · 58 lines · 0 tokens per session scan A aa7b96d7b645

Subscribe to this mod's changes

readme is a cursor rule published in the GitHub repository tantodefi/xmtpauth (3 stars, last pushed 11mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 290 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.