Files
NixOS/specs/001-mcp-server/quickstart.md
Danilo Reyes 527fad8da0 init
2026-01-30 22:48:02 -06:00

10 lines
817 B
Markdown

# Quickstart: MCP Server for Repo Maintenance
1) **Prereqs**: Python 3.12, `uv` or `pip`, and Codex CLI installed locally.
2) **Install**: From repo root, `cd scripts/mcp-server` and run `uv pip install -e .` (or `pip install -e .` if uv unavailable).
3) **Run tests**: `pytest --maxfail=1 --disable-warnings -q` (adds lint/format checks via ruff/black in CI).
4) **Launch MCP server**: `python -m mcp_server.server` (stdio mode).
5) **Connect Codex CLI**: Configure Codex to use the local MCP endpoint (stdin transport) and run `listTools` to verify catalog.
6) **Docs alignment**: If adding/updating tools, run `syncDocs` to confirm docs match; update `docs/` MCP section accordingly.
7) **CI behavior**: Gitea runs lint/format/tests when `scripts/**` or `docs/**` change; fix failures before merging.