johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Improve Claude Code plugin quickstart documentation

Browse Source 
Make it clearer that the Claude Code plugin is the recommended
installation method for Claude Code users.

Changes:
- Add Claude Code plugin option to "Instant start" section at top
- Expand plugin benefits (zero setup, MCP tools, agent-ready)
- List example MCP tool names for agents
- Clarify that agents can use MCP directly vs Bash commands

This addresses the issue where agents didn't know they could use
the MCP tools and were falling back to Bash commands instead.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Steve Yegge
2025-10-14 16:39:37 -07:00
parent 800ed300a6
commit e6697939f0
1 changed files with 28 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -10,6 +10,13 @@ Drop Beads into any project where you're using a coding agent, and you'll enjoy
Instant start: Instant start:
**Claude Code users:**
```bash
/plugin marketplace add steveyegge/beads
/plugin install beads
```
**Everyone else:**
```bash ```bash
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/install.sh | bash curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/install.sh | bash
``` ```
@@ -82,9 +89,9 @@ paru -S beads-git
Thanks to [@v4rgas](https://github.com/v4rgas) for maintaining the AUR package! Thanks to [@v4rgas](https://github.com/v4rgas) for maintaining the AUR package!
### Claude Code Plugin ### Claude Code Plugin (Recommended for Claude Code Users)
Prefer a one-command installation in Claude Code? Install the beads plugin for instant access via slash commands and MCP tools: **The easiest way to use Beads in Claude Code!** One-command installation with zero configuration:
```bash ```bash
# In Claude Code # In Claude Code
@@ -92,11 +99,25 @@ Prefer a one-command installation in Claude Code? Install the beads plugin for i
/plugin install beads /plugin install beads
``` ```
The plugin includes: **Why use the plugin?**
- Slash commands: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc. - ✨ **Zero manual setup** - No need to install Go or build from source
- Full MCP server with all bd tools - 🔧 **MCP tools built-in** - Agents can use beads directly without Bash commands
- Task agent for autonomous execution - ⚡ **Instant availability** - Works immediately after plugin install
- Auto-configured for instant use - 🎯 **Slash commands** - Quick access to common operations
- 🤖 **Agent-ready** - MCP tools like `mcp__plugin_beads_beads__ready`, `mcp__plugin_beads_beads__create`, etc.
**What you get:**
- **Slash commands**: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc.
- **Full MCP server**: All bd tools available via MCP protocol (agents use these automatically)
- **Task agent**: Autonomous task execution
- **Auto-configured**: bd CLI installed and configured automatically
**For agents:** After plugin installation, agents can use MCP tools directly instead of calling `bd` commands via Bash. The plugin provides tools like:
- `mcp__plugin_beads_beads__ready` - Find ready work
- `mcp__plugin_beads_beads__create` - Create new issues
- `mcp__plugin_beads_beads__update` - Update issue status
- `mcp__plugin_beads_beads__show` - Show issue details
- ...and all other bd commands
See [PLUGIN.md](PLUGIN.md) for complete plugin documentation. See [PLUGIN.md](PLUGIN.md) for complete plugin documentation.