Add a getting-started guide for the MCP workflow - #337
Merged
Merged
Conversation
The repo documented how to CONNECT a client (docs/runbooks/connect-a-client.md) and demoed the loop through the web UI (docs/demo/staging-walkthrough.md), but had no task-oriented first-run guide for the recommended path: driving OpenBases through the MCP tools inside a client you already use. docs/getting-started.md walks it end to end -- connect the MCP, create a project (two owners), attach repositories, plan and file beads (free), dispatch (spends), then watch and read the result. Each step shows both what to say to the client and the tool plus arguments underneath, taken from internal/mcp/tools.go so the examples match the real schemas. It also covers what is deliberately NOT an MCP tool (changing owners/cell/membership, detach, check command) and where those live instead. Linked from the README (the "Connect a client" section and the Layout list). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/getting-started.md— a task-oriented first-run guide for the recommended way to use OpenBases: driving it through the MCP tools inside a client you already use (Claude, Claude Code, Codex).The repo already documented how to connect a client (
docs/runbooks/connect-a-client.md) and demoed the loop through the web UI (docs/demo/staging-walkthrough.md), but had no end-to-end "how do I actually run my first work" guide for the MCP path. This fills that gap.The guide walks
Connect the MCP → create a project (two owners) → attach repositories → plan and file beads (free) → dispatch (spends) → watch and read the pull request.
Each step shows both what to say to the client and the tool + arguments underneath, taken from
internal/mcp/tools.goso the examples match the real schemas. It also covers what is deliberately not an MCP tool — changing owners/cell/membership, detaching a repo, setting a check command — and where those live instead (web admin / API).Also
Linked from the README: a pointer in the "Connect a client" section and an entry in the Layout list.
Checks
Links verified to resolve; disclosure guard clean (
no new disclosures). Docs-only change.🤖 Generated with Claude Code
Summary by CodeRabbit