Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 22 additions & 5 deletions packages/claude-code-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ claude plugin add codingbuddy
- **EVAL**: Evaluate code quality and suggest improvements
- **AUTO**: Autonomous PLAN → ACT → EVAL cycle

### Commands
### Commands (codingbuddy:* namespace)

All commands use the `codingbuddy:` namespace to avoid collisions with Claude Code built-ins.

- `/codingbuddy:plan` - Enter PLAN mode
- `/codingbuddy:act` - Enter ACT mode
- `/codingbuddy:eval` - Enter EVAL mode
Expand Down Expand Up @@ -56,18 +59,32 @@ Reusable workflows for consistent development:
- Refactoring
- And more...

## MCP Integration (Required)
## Feature Availability

The plugin works standalone with core features. MCP integration unlocks the full experience:

| Feature | Standalone | With MCP |
|---------|:----------:|:--------:|
| PLAN/ACT/EVAL/AUTO keyword triggers | ✅ | ✅ |
| Specialist agent prompts | ✅ | ✅ |
| Slash commands (codingbuddy:*) | ✅ | ✅ |
| Dynamic checklists | — | ✅ |
| Context persistence across modes | — | ✅ |
| Rule search & impact reports | — | ✅ |
| Session briefings & recovery | — | ✅ |

## MCP Integration (Recommended)

This plugin requires the CodingBuddy MCP server for full functionality:
Install the CodingBuddy MCP server to unlock the full feature set:

```bash
npm install -g codingbuddy
```

The MCP server provides:
- Agents, commands, and skills from `packages/rules/.ai-rules/` (single source of truth)
- Checklists and specialist agent recommendations
- Dynamic checklists and specialist agent recommendations
- Context management for PLAN/ACT/EVAL workflow
- Rule search, impact reports, and session recovery

## Architecture

Expand Down
33 changes: 33 additions & 0 deletions packages/claude-code-plugin/scripts/build.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,39 @@ describe('build script orchestration', () => {
});
});

// ============================================================================
// README Messaging — standalone-aware MCP messaging
// ============================================================================
describe('README messaging', () => {
const pluginRoot = path.resolve(__dirname, '..');
const readmePath = path.join(pluginRoot, 'README.md');

let readmeContent: string;

beforeAll(() => {
readmeContent = fs.readFileSync(readmePath, 'utf8');
});

it('marks MCP Integration as Recommended, not Required', () => {
expect(readmeContent).toContain('## MCP Integration (Recommended)');
expect(readmeContent).not.toContain('## MCP Integration (Required)');
});

it('does not claim MCP is required for full functionality', () => {
expect(readmeContent).not.toContain('requires the CodingBuddy MCP server');
});

it('includes the Feature Availability table', () => {
expect(readmeContent).toContain('## Feature Availability');
expect(readmeContent).toContain('| Feature | Standalone | With MCP |');
});

it('shows standalone features in the availability table', () => {
expect(readmeContent).toContain('PLAN/ACT/EVAL/AUTO keyword triggers');
expect(readmeContent).toContain('Slash commands (codingbuddy:*)');
});
});

// ============================================================================
// Packaging Integration — namespaced command assets
// ============================================================================
Expand Down
22 changes: 18 additions & 4 deletions packages/claude-code-plugin/scripts/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,18 +112,32 @@ Reusable workflows for consistent development:
- Refactoring
- And more...

## MCP Integration (Required)
## Feature Availability

This plugin requires the CodingBuddy MCP server for full functionality:
The plugin works standalone with core features. MCP integration unlocks the full experience:

| Feature | Standalone | With MCP |
|---------|:----------:|:--------:|
| PLAN/ACT/EVAL/AUTO keyword triggers | ✅ | ✅ |
| Specialist agent prompts | ✅ | ✅ |
| Slash commands (codingbuddy:*) | ✅ | ✅ |
| Dynamic checklists | — | ✅ |
| Context persistence across modes | — | ✅ |
| Rule search & impact reports | — | ✅ |
| Session briefings & recovery | — | ✅ |

## MCP Integration (Recommended)

Install the CodingBuddy MCP server to unlock the full feature set:

\`\`\`bash
npm install -g codingbuddy
\`\`\`

The MCP server provides:
- Agents, commands, and skills from \`packages/rules/.ai-rules/\` (single source of truth)
- Checklists and specialist agent recommendations
- Dynamic checklists and specialist agent recommendations
- Context management for PLAN/ACT/EVAL workflow
- Rule search, impact reports, and session recovery

## Architecture

Expand Down
Loading