zulipchat-mcp: Instructions file for Claude Code

CLAUDE.md

zulipchat-mcp CLAUDE.md is an instructions file for Claude Code from akougkas/zulipchat-mcp. It costs 3,286 tokens per session, scanned C, original, MIT.

A development guide for ZulipChat MCP, a server that lets AI assistants interact with Zulip team-chat workspaces through the Model Context Protocol.

In plain words
What is it for?
It is for installing and running the server with uv, testing it with pytest, checking code quality, and managing its DuckDB-backed persistence.
Why use it?
It gives contributors the project’s setup, run, test, formatting, type-checking, and security-check commands.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: reads .claude/ paths; mentions CLAUDE.md; mentions Claude Code.

This is akougkas/zulipchat-mcp's own configuration. It tells Claude Code 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/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/akougkas/zulipchat-mcp

Made for: Claude Code.

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 CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/akougkas/zulipchat-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/akougkas/zulipchat-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,286 This file is loaded in full into every session.
When invoked 3,286 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.03286 $0.03286
Opus 5 $0.01643 $0.01643
Sonnet 5 $0.00657 $0.00657
Haiku 4.5 $0.00329 $0.00329

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

Security

Grade C, and why

zulipchat-mcp CLAUDE.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 10d 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.

rm -rf .venv .pytest_cache **/__pycache__ htmlcov .coverage* coverage.xml .uv_cache
CLAUDE.md · 292 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Current Status (v0.7.3-beta.1)

Published: PyPI | TestPyPI

Install: uvx zulipchat-mcp --zulip-config-file ~/.zuliprc

Project Overview

ZulipChat MCP Server v0.7.3-beta.1 is a Model Context Protocol (MCP) server that enables AI assistants to interact with Zulip Chat workspaces. The project uses FastMCP framework with DuckDB for persistence and async-first architecture.

Essential Development Commands

Environment Setup

# Install dependencies. Never use pip; this project uses uv.
uv sync

# Run the MCP server locally
uv run zulipchat-mcp --zulip-config-file ~/.zuliprc

# Quick run via uvx
uvx zulipchat-mcp

Testing & Quality Assurance

# Run tests (60% coverage gate)
uv run pytest -q

# Skip slow/integration tests for faster feedback
uv run pytest -q -m "not slow and not integration"

# Full coverage report
uv run pytest --cov=src

# Linting and formatting
uv run ruff check .
changed_py=$(git diff --name-only -- '*.py')
[ -z "$changed_py" ] || uv run black --check $changed_py
uv run mypy src

# Security checks (optional)
uv run bandit -q -r src
uv run safety check

Development Testing

# Test connection to Zulip (uses installed package; safe inside or outside the repo)
uv run python -c "from zulipchat_mcp.config import ConfigManager; from zulipchat_mcp.core.client import ZulipClientWrapper; c = ZulipClientWrapper(ConfigManager()); print('Connected:', c.identity_name)"

# Import validation
uv run python -c "from zulipchat_mcp.server import main; print('OK')"

Architecture Overview

Core Structure

src/zulipchat_mcp/
├── core/           # Business logic (client, identity, commands, batch processing)
├── tools/          # MCP tool implementations (messaging, streams, search, events, users, files)
├── utils/          # Shared utilities (logging, database, health, metrics)
├── services/       # Background services (scheduler, message listener)
├── integrations/   # AI client integrations
└── config.py       # Configuration management

Read the full file on GitHub · 292 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. 10d ago First seen · 292 lines · 3,286 tokens per session scan C e7a8d690fdf5

Subscribe to this mod's changes

zulipchat-mcp CLAUDE.md is an instructions file published in the GitHub repository akougkas/zulipchat-mcp (27 stars, last pushed 1mo ago), licensed MIT. It adds 3,286 tokens to every session, about $0.0164 per session on Opus 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

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,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 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

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

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 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,469 tokens