speky AGENTS.md

speky AGENTS.md is an instructions file for Codex, OpenCode from agagniere/speky. It costs 1,266 tokens per session, scanned A, original, MIT.

A project guide for Speky, a Python tool that stores project requirements and tests in YAML or TOML files and generates documentation and PDFs.

In plain words
What is it for?
Use it to maintain version-controlled specifications, run their tests, create HTML or PDF documentation, and provide specs to AI assistants.
Why use it?
It explains how to install, test, format, validate specifications, generate documentation, and expose those specifications to AI agents through MCP.

Instructions file for CodexOpenCode

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/agagniere/speky/agents-md
Clone the repo
git clone --depth 1 https://github.com/agagniere/speky

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 speky AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/agagniere/speky/agents-md.svg)](https://agentmods.dev/instructions/agagniere/speky/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/agagniere/speky/agents-md"><img src="https://agentmods.dev/badge/instructions/agagniere/speky/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,266 This file is loaded in full into every session.
When invoked 1,266 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.01266 $0.01266
Opus 5 $0.00633 $0.00633
Sonnet 5 $0.00253 $0.00253
Haiku 4.5 $0.00127 $0.00127

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

Security

Grade A, and why

speky 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 4d 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.

AGENTS.md · 100 lines

How it starts

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

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository.

Project Overview

Speky is a Python tool for writing project specifications (requirements and tests) in YAML or TOML, version-controlled alongside code. It generates static HTML (via Sphinx/MyST) and PDFs (via Typst), and exposes specs to LLM agents via an MCP server.

Commands

Setup:

uv sync

Run all tests:

uv run pytest --import-mode importlib --quiet

Run a single test:

uv run pytest --import-mode importlib tests/test_mcp_server.py::TestInitialization::test_initialize -v

Format and lint:

uv run --dev ruff format python tests
uv run --dev ruff check python tests
uv run --dev ruff check --fix python tests

Validate YAML specs:

make -C specs check

Generate Markdown and HTML from specs:

uv run speky specs/speky.yaml --output-folder markdown
uv run --with furo,sphinx-design,sphinx-copybutton,myst-parser sphinx-build -M html markdown output --conf-dir .

Sphinx's conf.py must set project, include 'substitution' in myst_enable_extensions, and set myst_substitutions = {'project': project}.

Architecture

The project has two Python packages under python/:

speky — CLI tool

  • main.py — Argument parsing and orchestration
  • specification.py — Loads YAML/TOML files and kind: project manifests, resolves cross-references, scans source code for speky:<project>#<ID> tags, computes test-plan coverage
  • models.pyRequirement, Test, Comment, Manifest, SourceLinkConfig data models
  • scanner.py — Tree-sitter based scanner extracting code references from Python/Go/Rust/Bash sources
  • generators/markdown.py — MyST Markdown output
  • utils.py, log_formatter.py — Field-import helpers and CLI log formatting
  • assets/ — Default logging.yaml config and speky.css copied into the generated Markdown folder

speky_mcp — MCP server

Exposes specs over JSON-RPC 2.0 to LLM clients (e.g., Claude).

  • server.py — Startup, initialization, request dispatch
  • tools.py — Tool implementations (search, get, list operations)
  • protocol.py — JSON-RPC error types

Read the full file on GitHub · 100 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. 4d ago First seen · 100 lines · 1,266 tokens per session scan A 6e8f7dd418e3

Subscribe to this mod's changes

speky AGENTS.md is an instructions file published in the GitHub repository agagniere/speky (2 stars, last pushed 3mo ago), licensed MIT. It adds 1,266 tokens to every session, about $0.0063 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.

Related

Other instructions, from other repositories

river-review GEMINI.md

Gemini CLI instructions for s977043/river-review, covering gemini instructions (river-review), 必須チェック, gemini-specific tips, prompt assembly and development tips.

s977043/river-review · 318 tokens

ship-it open-pr.instructions.md

Instructions for khrichtchatyi/ship-it: When the user asks to open, create, or submit a pull request, follow the skill in skills/open-pr/SKILL.md in full: verify gh is authenticated, resolve the target repository and default branch, push the current branch, open one pull request with a title and body derived from the…

khrichtchatyi/ship-it · 84 tokens

agent-skills CLAUDE.md

Instructions for mindbox-cloud/agent-skills, covering agent-skills — developer guide for claude code, repository purpose, repository structure, how to add a new plugin and step 1 — create the directory structure.

mindbox-cloud/agent-skills · 1,143 tokens

my-claude-skills CLAUDE.md

Instructions for brody-0125/my-claude-skills, covering claude code skills repository, validation commands, sub-kopring-engineer: kotlin/java 코드 컨벤션 검증, numerical: 수치 연산 코드 검증 and sub-test-engineer: 문서 일관성 검증.

brody-0125/my-claude-skills · 1,093 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens