Skip to content

docs: simplify mcp config to bare reqstool mcp (reqstool 0.10.0+) #22

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
jimisola merged 1 commit into from
May 10, 2026
Merged

docs: simplify mcp config to bare reqstool mcp (reqstool 0.10.0+) #22

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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ OpenSpec integration conventions, auto-applied when working with spec.md files:

## MCP server

The [reqstool MCP server](https://github.com/reqstool/reqstool-client) (reqstool ≥ 0.9.0) exposes structured tools for AI agents: `get_status`, `list_requirements`, `get_requirement_status`, and more.
The [reqstool MCP server](https://github.com/reqstool/reqstool-client) (reqstool ≥ 0.10.0) exposes structured tools for AI agents: `get_status`, `list_requirements`, `get_requirement_status`, and more.

The `/reqstool:init` command can configure it automatically. To set it up manually, add to `.mcp.json` in your project root (project-scoped) or `~/.config/claude/mcp.json` (global):

Expand All @@ -163,12 +163,14 @@ The `/reqstool:init` command can configure it automatically. To set it up manual
"mcpServers": {
"reqstool": {
"command": "reqstool",
"args": ["mcp", "local", "-p", "<your-system-path>"]
"args": ["mcp"]
}
}
}
```

With no arguments, `reqstool mcp` walks up from cwd to find `.reqstool-ai.yaml` and serves the dataset at `system.path` from it — so the same `.mcp.json` works for every contributor regardless of where the repo is cloned. For older reqstool versions (or when no `.reqstool-ai.yaml` is present), pass an explicit path: `["mcp", "local", "-p", "<your-system-path>"]`.

When configured, skills like `/reqstool:status` use MCP for structured data. If the server is not available they fall back to `reqstool status local` automatically, notifying you when they do.

## Prerequisites
Expand Down
8 changes: 6 additions & 2 deletions plugins/reqstool/skills/reqstool/init/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Create or update `.reqstool-ai.yaml` configuration for this project.

5. **Configure MCP server (optional)**

Offer to configure the reqstool MCP server (requires reqstool ≥ 0.9.0):
Offer to configure the reqstool MCP server (requires reqstool ≥ 0.10.0):

> The reqstool MCP server gives AI tools structured access to your requirements.
> Would you like me to add the MCP server configuration?
Expand All @@ -96,12 +96,16 @@ Create or update `.reqstool-ai.yaml` configuration for this project.
"mcpServers": {
"reqstool": {
"command": "reqstool",
"args": ["mcp", "local", "-p", "<system.path>"]
"args": ["mcp"]
}
}
}
```

`reqstool mcp` (no arguments) auto-detects the dataset by walking up from
the server's working directory to find `.reqstool-ai.yaml` and using its
`system.path` — so this same config is portable across contributors.

If the chosen file already has a `reqstool` entry, show it and ask before overwriting.

If `reqstool` is not yet installed, skip this step and tell the user:
Expand Down
Loading