designing-real-world-ai-agents-workshop
CLAUDE.md512 starsChanged 7 months agoMITView on GitHub
We are building an educative workshop teaching people how to build AI systems by implementing a hybrid AI system containing a Deep Research Agent and a Writing Workflow, both served as MCP servers and connected to a harness such as Claude Code or Cursor. We use ruff as our formatter and linter. First always fix the formatting and linting errors with the fix commands: Then, check if there are any errors that couldn't be fixed automatically and fix them: We…
- Reads credentials
In this repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- implement_yourself/AGENTS.mdAGENTS.md
- implement_yourself/CLAUDE.mdCLAUDE.md
- developing-with-streamlitSkill
- research-and-writeSkill
- researchSkill
- write-postSkill
The file
We split this CLAUDE.md into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 43
Use the context7 MCP server to find out more about the tech stack usage and good practices.
≈ “Common” is an estimate: at least 1 in 5 of the 27,641 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Project
We are building an educative workshop teaching people how to build AI systems by implementing a hybrid AI system containing a Deep Research Agent and a Writing Workflow, both served as MCP servers and connected to a harness such as Claude Code or Cursor.
Project Structure
project-root/
├── src/
│ ├── research/ # Deep Research Agent MCP server
│ │ ├── server.py # FastMCP entry point
│ │ ├── config/ # Settings, constants, prompt templates
│ │ ├── models/ # Pydantic schemas for structured LLM output
│ │ ├── app/ # Business logic handlers
│ │ ├── tools/ # MCP tool implementations
│ │ ├── routers/ # MCP tool, resource, and prompt registration
│ │ └── utils/ # Gemini client, file I/O, markdown helpers
│ └── writing/ # LinkedIn Writer MCP server
│ ├── server.py # FastMCP entry point
│ ├── profiles/ # Shipped markdown profiles (structure, terminology, character)
│ ├── config/ # Settings, constants, prompt templates
│ ├── models/ # Pydantic schemas (Post, Review, Profiles)
│ ├── app/ # Business logic handlers (writer, reviewer, image, profile loader)
│ ├── tools/ # MCP tool implementations
│ ├── routers/ # MCP tool, resource, and prompt registration
│ └── utils/ # Gemini client helpers (text + Imagen)
├── inputs/ # Seed and guideline files
├── scripts/ # Entrypoints and test scripts
└── .env.example # All supported env varsTech Stack
- Data validation and structuring: Pydantic
- Settings: Pydantic Settings
- MCP Server Framework: FastMCP
- CLI: Click
- Logging: Native Python logger (never prints!)
- LLM API: Gemini
- Observability and evals: Opik
Access Documentation
Use the context7 MCP server to find out more about the tech stack usage and good practices.
Running QA
We use ruff as our formatter and linter.
First always fix the formatting and linting errors with the fix commands:
make format-fix
make lint-fixThen, check if there are any errors that couldn't be fixed automatically and fix them:
make format-check
make lint-checkRunning Code
We manage all the core commands through GNU Make as our command center. File available at @Makefile. Run all the commands with make ...
We use uv to manage our Python project such as the virtual environment(s), dependencies, and overall package the project.
Thus, use uv to run any custom command that is not present in the @Makefile, but uses Python: uv run python ...
Fallback when make is not installed
Some environments (fresh WSL, minimal containers, corporate dev images) ship without GNU Make. Do not block on a missing make — every target in the Makefile is a thin wrapper around a one-line uv run ... invocation. When make <target> fails with command not found: make, open the Makefile, find the target's recipe, and run the underlying command directly. Example: make test-research-workflow becomes uv run python scripts/test_research_workflow.py --working-dir test_logic --iterations 2 (after the two mkdir -p / cp setup lines also shown in the recipe). The Makefile's export PYTHONPATH=./src/ and include .env are already handled by uv run reading the project's environment + .env, so no extra shell setup is needed.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

