jawz/NixOS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mcp server done

Browse Source
This commit is contained in:
Danilo Reyes
2026-02-01 10:36:54 -06:00
parent ecf058aacf
commit 8946ade5e8
15 changed files with 214 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
specs/001-mcp-server/quickstart.md
View File

@@ -1,9 +1,9 @@
# 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.
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.