Skip to content
This repository was archived by the owner on Mar 21, 2026. It is now read-only.

Commit 22aad5a

Browse files
bnori-agent
andcommitted
feat: task-006 - Update documentation
Updated three README files to document TaskMaster integration, new CLI subcommands, and OpenCode executor support: README.md changes: - Added OpenCode as fourth executor option - Updated workflow section with new CLI subcommands (run, status, list-tasks) - Added visual progress display section with Unicode box-drawing examples - Added TaskMaster format migration guide with prd.json → tasks.json - Updated all examples to use new subcommand syntax - Updated key files table to reflect tasks.json format ralph/README.md changes: - Added TaskMaster integration section with task format documentation - Documented new CLI subcommands (run, status, list-tasks) with examples - Added dependency management section (dependsOn, blockedBy) - Added visual progress display documentation with status icons - Updated environment variables to include OPENCODE_MODEL and TASKMASTER_URL - Added hybrid mode documentation (file-based vs MCP) - Expanded breaking changes section with new features list - Updated project structure to show new modules (taskmaster_adapter, progress_display) README-MCP.md changes: - Added TaskMaster MCP integration section - Documented TaskMaster MCP server setup (file-based and MCP modes) - Added TaskMaster CLI integration instructions - Added MCP client config example for TaskMaster - Documented TaskMaster features in Ralph (status management, dependencies, visual progress) - Added migration reference to main README All quality checks passing (mypy, ruff, pytest). 🤖 Generated with [Nori](https://nori.ai) Co-Authored-By: Nori <contact@tilework.tech>
1 parent e0fd192 commit 22aad5a

4 files changed

Lines changed: 539 additions & 57 deletions

File tree

README-MCP.md

Lines changed: 103 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ralph MCP Integration 🚀
22

3-
Ralph now supports **FastMCP 3.0** with both server and client capabilities!
3+
Ralph now supports **FastMCP 3.0** with both server and client capabilities, plus TaskMaster-AI integration for rich task management!
44

55
## Features
66

@@ -20,9 +20,11 @@ Ralph exposes its autonomous agent capabilities as an MCP server with:
2020

2121
**As CLI (default):**
2222
```bash
23+
# Using new Python CLI with subcommands
24+
uv run ralph run --tool codex --max-iterations 3
25+
26+
# Or using deprecated bash wrapper
2327
./ralph.sh --agent codex 3
24-
# or
25-
uv run --script ralphython.py --agent codex 3
2628
```
2729

2830
**As MCP Server (HTTP):**
@@ -77,3 +79,101 @@ Add to your MCP client settings (e.g., Claude Desktop):
7779
- Supports both CLI and MCP modes via `--mcp` flag
7880
- Model: gpt-5.2-codex (configurable via `CODEX_MODEL` env var)
7981

82+
## TaskMaster MCP Integration
83+
84+
Ralph now integrates with TaskMaster-AI for advanced task management via MCP protocol.
85+
86+
### Setup TaskMaster MCP Server
87+
88+
**Option 1: File-Based (Default)**
89+
90+
No setup required! Ralph reads/writes `tasks.json` directly:
91+
92+
```bash
93+
# Works out of the box
94+
uv run ralph status
95+
uv run ralph list-tasks
96+
uv run ralph run --tool amp
97+
```
98+
99+
**Option 2: TaskMaster MCP Server**
100+
101+
Connect to a TaskMaster MCP server for remote task management:
102+
103+
```bash
104+
# Set TaskMaster server URL
105+
export TASKMASTER_URL="http://localhost:8080"
106+
107+
# Ralph will use MCP instead of file-based access
108+
uv run ralph status
109+
uv run ralph run --tool amp
110+
```
111+
112+
### TaskMaster CLI Integration
113+
114+
Ralph also supports the TaskMaster CLI for task operations:
115+
116+
```bash
117+
# Install TaskMaster CLI
118+
npm install -g @taskmaster-ai/cli
119+
120+
# Ralph will detect and use it automatically
121+
uv run ralph status
122+
uv run ralph list-tasks
123+
```
124+
125+
### MCP Client Config for TaskMaster
126+
127+
Add TaskMaster to your MCP client settings (e.g., Claude Desktop):
128+
129+
```json
130+
{
131+
"mcpServers": {
132+
"taskmaster": {
133+
"command": "taskmaster",
134+
"args": ["mcp", "start"]
135+
},
136+
"ralph": {
137+
"command": "uv",
138+
"args": ["run", "ralph", "mcp", "start"],
139+
"env": {
140+
"TASKMASTER_URL": "mcp://taskmaster"
141+
}
142+
}
143+
}
144+
}
145+
```
146+
147+
### TaskMaster Features in Ralph
148+
149+
1. **Task Status Management**: pending → in-progress → done
150+
2. **Dependency Tracking**: `dependsOn` and `blockedBy` fields
151+
3. **Visual Progress**: Unicode progress bars and task trees
152+
4. **CLI Commands**: `status`, `list-tasks` with filtering
153+
5. **Hybrid Mode**: File-based or MCP server
154+
155+
### Example: Using Ralph with TaskMaster
156+
157+
```bash
158+
# Check current status
159+
uv run ralph status
160+
161+
# Expected output:
162+
# ==================================================
163+
# Progress: [████████████░░░░░░░░] 60.0%
164+
# Completed: 3/5 | In Progress: 1 | Pending: 1 | Blocked: 0
165+
# ==================================================
166+
167+
# List pending tasks
168+
uv run ralph list-tasks --filter pending
169+
170+
# Run autonomous loop
171+
uv run ralph run --tool amp --max-iterations 10
172+
```
173+
174+
### Migration from prd.json to tasks.json
175+
176+
Ralph has migrated from legacy `prd.json` format to TaskMaster's `tasks.json` format.
177+
178+
See the main [README.md](README.md) for the complete migration guide.
179+

0 commit comments

Comments
 (0)