swarms: Instructions file for Codex

AGENTS.md

swarms AGENTS.md is an instructions file for Codex, OpenCode from kyegomez/swarms. It costs 643 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for Swarms, a Python framework for coordinating multiple AI agents. They explain where to find the full guidance, examples, current documentation, and contribution rules.

In plain words
What is it for?
Use them when changing or contributing to the Swarms repository, especially when writing Python code that uses its agents or multi-agent structures.
Why use it?
They give coding agents the project context and current sources they need, reducing mistakes caused by outdated API knowledge or incorrect imports.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions CLAUDE.md; mentions Claude Code; mentions AGENTS.md.

This is kyegomez/swarms's own configuration. It tells Codex and OpenCode how to work on swarms itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything swarms configures →

About the project

Swarms is a Python framework for coordinating multiple autonomous language-model agents into workflows such as sequential, concurrent, or hierarchical systems. It is used to build multi-step applications in which agents combine language models, tools, and memory. The catalogue entries provide agent-oriented skills, instructions, and an agent for working with Swarms.

kyegomez/swarms · 7,353 stars · on GitHub · docs.swarms.world

Reuse

Borrowing it

Nothing to install: this file belongs to kyegomez/swarms. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/kyegomez/swarms/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/kyegomez/swarms

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/kyegomez/swarms/agents-md/github.svg)](https://agentmods.dev/instructions/kyegomez/swarms/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/kyegomez/swarms/agents-md"><img src="https://agentmods.dev/badge/instructions/kyegomez/swarms/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for swarms AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/kyegomez/swarms/agents-md"><img src="https://agentmods.dev/badge/instructions/kyegomez/swarms/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 643 This file is loaded in full into every session.
When invoked 643 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.00643 $0.00643
Opus 5.5 $0.00257 $0.00257
Sonnet 5.5 $0.00129 $0.00129
Haiku 4.5 $0.00064 $0.00064

Measured 8d ago against content hash 7d402f7bb763, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

swarms 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 8d 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 · 45 lines

How it starts

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

AGENTS.md

Guidance for AI coding agents (Codex, Cursor, Copilot, Jules, Claude Code and others) working with Swarms, a multi-agent orchestration framework for Python.

Quickstart

pip install -U swarms
export OPENAI_API_KEY="sk-..."   # or any provider key
from swarms import Agent

agent = Agent(agent_name="Analyst", model_name="gpt-5.4", max_loops=1)
print(agent.run("Summarise the current state of LLM research."))

Where to look

  • CLAUDE.md: the full guide. Agent parameters, every multi-agent structure, tools, streaming, memory, MCP, and how to choose between them. Read it before writing Swarms code.
  • SKILL.md: a condensed version packaged as an agent skill.
  • examples/: hundreds of runnable examples. One is probably close to what you need.
  • Docs MCP server: https://docs.swarms.world/mcp, no key. Search the current docs instead of relying on training data; names changed across v12 to v16.
  • Marketplace MCP server: https://swarms.world/mcp. Listing tools needs no key; calling them needs a Swarms API key as Authorization: Bearer <key>.
  • Plain-text docs: llms.txt and llms-full.txt.

Rules

  1. Import from the top level: from swarms import Agent, not from swarms.structs.agent import Agent.
  2. Give every agent a unique agent_name; memory and routing key on it.
  3. Prefer an explicit max_loops=N. Use "auto" only for open-ended work.
  4. Don't set streaming_on=True and streaming_callback on the same agent.

Contributing to this repository

  • Commit, PR and issue titles use WARP: [TYPE][Function/FileName][Short description].
  • Disclose AI authorship: a co-author trailer on commits and a "Generated with" line naming the agent and model on PRs and issues.
  • Format with black --line-length 70 and lint with ruff check ..
  • Removing unused code (a method, parameter, attribute or line) needs no new unit test. Delete the tests that only exercised it and run the module's existing tests.
  • Not every change needs a unit test. When you add one, keep it small and fast: one table-driven test per behaviour, stubbed model and network, no near-copies.
  • User-visible changes need a matching PR in swarms-framework-docs.

Read the full file on GitHub · 45 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. 8d ago Changed · +2 lines · +73 tokens per session 7d402f7bb763
  2. 10d ago First seen · 43 lines · 570 tokens per session scan A 307d5cd11d4b

Subscribe to this mod's changes

swarms AGENTS.md is an instructions file published in the GitHub repository kyegomez/swarms (7,353 stars, last pushed yesterday), licensed Apache-2.0. It adds 643 tokens to every session, about $0.0026 per session on Opus 5.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-10-27.

Related

swarms AGENTS.md compared with instructions from other repositories

swarms AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
swarms AGENTS.mdkyegomez/swarmsInstructions file7.4kyesterdayApache-2.0A643Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode