From 4978faefa589b1fa41fd996d08e184b8e6b20ca0 Mon Sep 17 00:00:00 2001
From: Jeremiah Lowin <153965+jlowin@users.noreply.github.com>
Date: Sat, 17 May 2025 19:18:37 -0400
Subject: [PATCH] Update AGENTS with repo overview

---
 AGENTS.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 000000000..5bb614195
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,24 @@
+# AGENTS
+
+This repository contains the FastMCP source code and documentation.
+It is organized as follows:
+
+- `src/fastmcp/` – the main library implementation. Key modules include:
+  - `server/` with the `FastMCP` server and supporting classes like `Context`.
+  - `client/` with the high-level `Client` for connecting to MCP servers.
+  - subpackages for `resources`, `prompts`, `tools`, and other utilities.
+- `tests/` – pytest-based unit tests for the library.
+- `docs/` – documentation written for Mintlify and published on gofastmcp.com.
+- `examples/` – small example applications demonstrating library usage.
+
+Before committing any changes, run:
+
+```bash
+uv sync           # install dependencies
+uv run pre-commit run --all-files
+uv run pytest
+```
+
+`pre-commit` runs Ruff, Prettier, and Pyright. Make sure changes under
+`src/` or `tests/` include corresponding tests. Please keep this file
+updated if the repository layout or tooling changes.