Skip to content

docs: add npx quickstart for MCP server (#201) #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cobusgreyling merged 1 commit into from
Jul 8, 2026
Merged

docs: add npx quickstart for MCP server (#201) #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Same patterns, different tools. Skills and state schemas are shared; only schedu
| Gemini CLI | [primitives-matrix § Gemini CLI](../docs/primitives-matrix.md#appendix-gemini-cli) — terminal-based loops via `gemini` + external scheduling |
| GitHub Actions | [github-actions/](./github-actions/) |
| Aider CLI | [primitives-matrix § Aider](../docs/primitives-matrix.md#appendix-aider-cli) — CLI-first loops via cron + `--read` skills |
| MCP connectors | [mcp/](./mcp/) — config example; reference server in [tools/mcp-server/](../tools/mcp-server/) |
| MCP connectors | [mcp/](./mcp/) — config example, including `loop-engineering.mcp.json`; reference server in [tools/mcp-server/](../tools/mcp-server/) |

Start with [primitives-matrix.md](../docs/primitives-matrix.md) to map capabilities.

Expand Down
19 changes: 19 additions & 0 deletions examples/mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ Practical, scoped examples for connecting loops to real tools via MCP (or equiva

**Core principle**: Give loops the *minimum* privilege they need. Prefer read + comment over write. Use human gates + worktrees for anything that mutates state.

## Run the loop-engineering MCP server

If you want to try the MCP server without cloning the repo, use the published package:

```bash
LOOP_PROJECT_ROOT=. npx @cobusgreyling/loop-mcp-server
```

Copy the example MCP configuration:

```bash
cp examples/mcp/loop-engineering.mcp.json <your-mcp-config-location>
```

Then point your MCP client to the command above.

The local clone/dev path still works if you want to inspect or change the server implementation directly; see the example configuration files below.

## Quick Patterns

| Connector | Typical Use | Recommended Scope | Pattern Fit |
Expand All @@ -17,6 +35,7 @@ Practical, scoped examples for connecting loops to real tools via MCP (or equiva

See the files in this directory:

- `loop-engineering.mcp.json` — starter config for the published MCP server.
- `github-readonly.mcp.json` (existing) — safe starting point for discovery.
- `github-propose.json` — read + limited write for comments and draft PRs (sign comments as the loop).
- `linear.json` — example for creating/updating issues from loop state.
Expand Down