Files
NixOS/specs/001-mcp-server/quickstart.md
Danilo Reyes 8946ade5e8
Some checks failed
MCP Tests / mcp-tests (pull_request) Failing after 4s
mcp server done
2026-02-01 10:36:54 -06:00

10 lines
752 B
Markdown

# Quickstart: MCP Server for Repo Maintenance
1) **Prereqs**: Nix with flakes enabled and Codex CLI installed locally.
2) **Install**: `nix profile install .#nixos-mcp` (or `nix develop .#mcp` for a dev shell).
3) **Run tests**: `./scripts/mcp-server/run-tests.sh`.
4) **Launch MCP server**: `nixos-mcp` (stdio mode).
5) **Connect Codex CLI**: Ensure `.codex/config.toml` points to `nixos-mcp` and `.codex/requirements.toml` allowlists it, then list tools via the MCP client to verify catalog.
6) **Docs alignment**: If adding/updating tools, run `sync-docs` 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.