Skip to content

Add a getting-started guide for the MCP workflow - #337

Merged
anuveyatsu merged 1 commit into
mainfrom
docs/getting-started-mcp
Sep 25, 2026
Merged

anuveyatsu merged 1 commit into
mainfrom
docs/getting-started-mcp

Conversation

@anuveyatsu

@anuveyatsu anuveyatsu commented Sep 25, 2026 •

Copy link
Copy Markdown
Member

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.go so 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

  • Documentation
    • Added an end-to-end guide for using OpenBases through MCP clients, from connecting and confirming access to creating projects and attaching repositories.
    • The guide covers filing and revising plans, dispatching ready work, and monitoring results.
    • Clarifies which activities are free versus paid, and documents dispatch refusal and concurrency conditions.

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>
@coderabbitai

coderabbitai Bot commented Sep 25, 2026

Copy link
Copy Markdown

Review in Change Stack →

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: f9f1af36-5934-413e-9184-6befb78af195

📥 Commits

Reviewing files that changed from the base of the PR and between 11d94e2 and 0c2c5a7.

📒 Files selected for processing (2)
  • README.md
  • docs/getting-started.md
 ______________________________________________________________________________________________________
< My code reviews are like a Tesla: fully electric, increasingly autonomous, and occasionally on fire. >
 ------------------------------------------------------------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@anuveyatsu
anuveyatsu merged commit 2ac4c0e into main Sep 25, 2026
6 of 7 checks passed
@anuveyatsu
anuveyatsu deleted the docs/getting-started-mcp branch September 25, 2026 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant