zulipchat-mcp: Instructions file for Codex

AGENTS.md

zulipchat-mcp AGENTS.md is an instructions file for Codex, OpenCode from akougkas/zulipchat-mcp. It costs 3,427 tokens per session, scanned C, original, MIT.

Repository instructions for ZulipChat MCP, a server that connects coding agents to Zulip chat and related services.

In plain words
What is it for?
Use them when developing or testing the server, configuring it locally, running its Python tests and checks, or adding integrations.
Why use it?
They give contributors the project's current structure, setup commands, testing checks, and coding conventions in one place.

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 akougkas/zulipchat-mcp's own configuration. It tells Codex and OpenCode how to work on zulipchat-mcp 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 zulipchat-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to akougkas/zulipchat-mcp. 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/akougkas/zulipchat-mcp/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/akougkas/zulipchat-mcp

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 zulipchat-mcp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/akougkas/zulipchat-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/akougkas/zulipchat-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/akougkas/zulipchat-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/akougkas/zulipchat-mcp/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 zulipchat-mcp AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/akougkas/zulipchat-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/akougkas/zulipchat-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,427 This file is loaded in full into every session.
When invoked 3,427 The same file — it is already loaded in full.
Security scan C 1 finding. 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.03427 $0.03427
Opus 5.5 $0.01371 $0.01371
Sonnet 5.5 $0.00685 $0.00685
Haiku 4.5 $0.00343 $0.00343

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

Security

Grade C, and why

zulipchat-mcp AGENTS.md scanned grade C with 1 finding 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 17d 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.

Recursive force deletehighDestructive command

rm -rf with a variable or a broad path is one typo away from removing the wrong tree.

- Testing strategy: always use `uv` (no direct Python invocations), keep tests isolated and network-free by mocking clients, aggressively clean caches/venv before major coverage pushes (`rm -rf .venv .pytest_cache **/__p
AGENTS.md · 202 lines

How it starts

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

Repository Guidelines

Current Status (v0.7.6)

Current release: v0.7.6 on PyPI. Install: uvx zulipchat-mcp.

Project Structure & Module Organization

  • Source code lives in src/zulipchat_mcp/:
    • tools/ (tool groups), core/ (client, cache, commands), services/ (listener, scheduler), integrations/ (client installers), utils/ (logging, metrics, db).
  • Tests are in tests/ (pytest with slow and integration markers).
  • Config via CLI flags or environment; copy .env.example to .env for local dev. Entry points: zulipchat-mcp, zulipchat-mcp-integrate, zulipchat-mcp-setup, zulipchat-mcp-hook.

Build, Test, and Development Commands

  • uv sync — install dependencies.
  • uv run zulipchat-mcp --zulip-config-file ~/.zuliprc [--enable-listener] — run server locally.
  • uvx zulipchat-mcp — quick run via uvx shim.
  • Companion commands require an explicit package source: uvx --from zulipchat-mcp zulipchat-mcp-integrate --help (also applies to setup and hook commands).
  • uv run python scripts/release_preflight.py --version 0.7.6 --allow-dirty — validate versions, documentation package sources, and release metadata. CI also runs this gate.
  • uv run pytest -q — run tests. Use -m "not slow and not integration" to skip long tests; --cov=src for coverage. Gate is set to 60%.
  • uv run ruff check . — lint; use Black on changed Python files; uv run mypy src — type-check.

Coding Style & Naming Conventions

  • Python 3.10+, 4‑space indent, Black line length 88, Ruff configured (pycodestyle, pyflakes, isort, bugbear, pyupgrade). Keep imports sorted.
  • Names: functions/variables snake_case, classes CamelCase, constants UPPER_SNAKE_CASE, modules lower_snake_case.py.
  • Tool groups should expose register_*_tools(mcp) mirroring patterns in src/zulipchat_mcp/tools/.

Testing Guidelines

  • Place tests under tests/ as test_*.py; classes Test*, functions test_*.
  • Mark long/external tests with @pytest.mark.slow or @pytest.mark.integration and gate in CI via markers.
  • Prefer fast, deterministic unit tests; mock Zulip API calls. Aim for meaningful coverage with pytest --cov=src.
  • Testing strategy: always use uv (no direct Python invocations), keep tests isolated and network-free by mocking clients, aggressively clean caches/venv before major coverage pushes (rm -rf .venv .pytest_cache **/__pycache__ htmlcov .coverage* coverage.xml .uv_cache && uv sync --reinstall), and maintain the coverage gate at 60% while adding minimal, targeted tests without altering functionality.

Read the full file on GitHub · 202 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. 17d ago Changed · +51 lines · +837 tokens per session e86111b4d9ea
  2. 1mo ago Changed · +4 lines · +81 tokens per session bac1b8b6d527
  3. 1mo ago First seen · 147 lines · 2,509 tokens per session scan C 96a8face605b

Subscribe to this mod's changes

zulipchat-mcp AGENTS.md is an instructions file published in the GitHub repository akougkas/zulipchat-mcp (33 stars, last pushed 17d ago), licensed MIT. It adds 3,427 tokens to every session, about $0.0137 per session on Opus 5.5. A static security scan graded it C with 1 finding (recursive force delete). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

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 · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,581 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens