Spaces:
Running
Running
Jeremiah Lowin commited on
Commit ·
84c02af
1
Parent(s): e1a5c52
Update AGENTS with repo overview
Browse files
AGENTS.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# AGENTS
|
| 2 |
+
|
| 3 |
+
This repository contains the FastMCP source code and documentation.
|
| 4 |
+
It is organized as follows:
|
| 5 |
+
|
| 6 |
+
- `src/fastmcp/` – the main library implementation. Key modules include:
|
| 7 |
+
- `server/` with the `FastMCP` server and supporting classes like `Context`.
|
| 8 |
+
- `client/` with the high-level `Client` for connecting to MCP servers.
|
| 9 |
+
- subpackages for `resources`, `prompts`, `tools`, and other utilities.
|
| 10 |
+
- `tests/` – pytest-based unit tests for the library.
|
| 11 |
+
- `docs/` – documentation written for Mintlify and published on gofastmcp.com.
|
| 12 |
+
- `examples/` – small example applications demonstrating library usage.
|
| 13 |
+
|
| 14 |
+
Before committing any changes, run:
|
| 15 |
+
|
| 16 |
+
```bash
|
| 17 |
+
uv sync # install dependencies
|
| 18 |
+
uv run pre-commit run --all-files
|
| 19 |
+
uv run pytest
|
| 20 |
+
```
|
| 21 |
+
|
| 22 |
+
`pre-commit` runs Ruff, Prettier, and Pyright. Make sure changes under
|
| 23 |
+
`src/` or `tests/` include corresponding tests. Please keep this file
|
| 24 |
+
updated if the repository layout or tooling changes.
|