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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ With pipx, Sugar's dependencies don't conflict with your project's dependencies.
- Self-correcting loops until tests pass
- Prevents single-shot failures

**Full docs:** [Memory System](docs/user/memory.md) | [OpenCode Integration](docs/user/opencode.md) | [Ralph Wiggum](docs/ralph-wiggum.md)
**Full docs:** [Memory System](docs/user/memory.md) | [Goose Integration](docs/user/goose.md) | [OpenCode Integration](docs/user/opencode.md) | [Ralph Wiggum](docs/ralph-wiggum.md)

## Configuration

Expand Down
22 changes: 14 additions & 8 deletions docs/user/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,20 +193,26 @@ sugar:

### Does Sugar work with Goose?

Yes. Sugar provides MCP (Model Context Protocol) server support for Goose and other MCP clients.
Yes! Sugar has full MCP integration with [Goose](https://block.github.io/goose).

**Option 1: Built-in Python MCP Server**
**Setup via Goose CLI:**
```bash
# Install with MCP dependencies
pip install sugarai[mcp]
goose configure
# Select "Add Extension" → "Command-line Extension"
# Name: sugar
# Command: npx -y sugarai-mcp
```

# Start the server
sugar mcp serve --port 8080
**Or add directly to** `~/.config/goose/config.yaml`:
```yaml
extensions:
sugar:
command: npx -y sugarai-mcp
```

**Option 2: Standalone TypeScript MCP Server**
This gives Goose access to Sugar's task management and memory features.

For npm-based installations, see `packages/mcp-server/` in the Sugar repository.
See the [Goose Integration Guide](goose.md) for full details.

### Can I use Sugar with my CI/CD?

Expand Down
128 changes: 128 additions & 0 deletions docs/user/goose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Sugar Goose Integration

Sugar integrates with [Goose](https://block.github.io/goose) (Block's open-source AI agent) via MCP (Model Context Protocol), providing task management and memory features directly in your Goose sessions.

## Overview

The Goose integration enables:
- **Task management** - Create, list, and manage Sugar tasks from Goose
- **Memory access** - Store and recall decisions, preferences, and patterns
- **Project context** - Get organized summaries of your project knowledge

## Quick Start

### Option 1: Goose CLI (Recommended)

```bash
goose configure
# Select "Add Extension" → "Command-line Extension"
# Name: sugar
# Command: npx -y sugarai-mcp
```

### Option 2: Direct Config Edit

Add to `~/.config/goose/config.yaml`:

```yaml
extensions:
sugar:
command: npx -y sugarai-mcp
```

After setup, restart Goose to load the Sugar extension.

## Prerequisites

- [Goose](https://block.github.io/goose) installed
- [Node.js](https://nodejs.org/) (for npx)
- Sugar initialized in your project (`sugar init`)

## Available MCP Tools

Once configured, Goose has access to these Sugar tools:

### Task Management

| Tool | Description |
|------|-------------|
| `createTask` | Add a new task to Sugar's queue |
| `listTasks` | List tasks with optional filtering |
| `viewTask` | Get detailed information about a task |
| `updateTask` | Modify task priority, status, or metadata |
| `removeTask` | Delete a task from the queue |
| `getStatus` | Get Sugar system status and queue stats |

### Memory System

| Tool | Description |
|------|-------------|
| `search_memory` | Semantic search over stored memories |
| `store_learning` | Store new decisions, preferences, or patterns |
| `get_project_context` | Get organized project summary |
| `recall` | Get formatted markdown context on a topic |
| `list_recent_memories` | List memories with optional type filter |

## Usage Examples

Once Sugar is configured in Goose, you can interact naturally:

**Task Management:**
```
"Add a task to fix the login timeout bug with high priority"
"Show me all pending bug fixes"
"What's the status of the Sugar queue?"
```

**Memory:**
```
"Remember that we use JWT with RS256 for authentication"
"What decisions have we made about the database?"
"Store this as an error pattern: connection timeouts need retry logic"
```

## Alternative: Python MCP Server

If you prefer not to use npx, Sugar also provides a built-in Python MCP server:

```bash
# Start the HTTP-based MCP server
sugar mcp serve --port 8080
```

Then configure Goose to connect to `http://localhost:8080`.

## Troubleshooting

### "Extension not found" or tools not available

1. Verify Node.js is installed: `node --version`
2. Test the MCP server manually: `npx -y sugarai-mcp`
3. Restart Goose after configuration changes

### "Not a Sugar project"

Sugar requires initialization in your project directory:

```bash
cd /path/to/your/project
sugar init
```

### Tools work but no memories/tasks

Ensure you're running Goose from a directory with a `.sugar/` folder, or that `SUGAR_PROJECT_ROOT` is set.

## Environment Variables

| Variable | Description | Default |
|----------|-------------|---------|
| `SUGAR_PROJECT_ROOT` | Override project directory | Current directory |
| `SUGAR_LOG_LEVEL` | Logging verbosity | `INFO` |

## Learn More

- [Memory System Guide](memory.md) - Full memory system documentation
- [CLI Reference](cli-reference.md) - All Sugar commands
- [Goose Documentation](https://block.github.io/goose) - Official Goose docs
- [MCP Server Package](https://www.npmjs.com/package/sugarai-mcp) - npm package details
10 changes: 10 additions & 0 deletions docs/user/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,16 @@ This creates:
- `logs/errors/` directory with sample error log for testing
- Auto-detects Claude CLI location

### 2. Enable MCP Features in Claude Code (Recommended)

To get the most out of Sugar, add the MCP server to Claude Code:

```bash
claude mcp add sugar -- sugar mcp memory
```

This gives Claude Code access to your project's memory system - decisions, preferences, error patterns, and more. See the [Memory System Guide](memory.md) for details.

**Claude CLI Detection:**
Sugar will automatically search for Claude CLI in common locations:
- `claude` (in PATH)
Expand Down
16 changes: 13 additions & 3 deletions docs/user/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,17 @@ This creates:
- `.sugar/config.yaml` - customizable settings
- `logs/errors/` - directory for error log monitoring

### 2. Add Your First Task
### 2. Enable MCP Features in Claude Code (Recommended)

To get the most out of Sugar, add the MCP server to Claude Code:

```bash
claude mcp add sugar -- sugar mcp memory
```

This gives Claude Code access to your project's memory - decisions, preferences, error patterns, and more.

### 3. Add Your First Task

Sugar accepts tasks in **two ways**:

Expand All @@ -82,7 +92,7 @@ Sugar will also automatically discover work from:
- Missing test coverage
- GitHub issues (when configured)

### 3. Check Status
### 4. Check Status

```bash
# View system status
Expand All @@ -95,7 +105,7 @@ sugar list
sugar view TASK_ID
```

### 4. Run Sugar
### 5. Run Sugar

```bash
# Test run (safe mode - no actual changes)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "sugarai"
version = "3.8.0.dev0"
version = "3.8.0.dev1"
description = "🍰 Sugar - The autonomous layer for AI coding agents. Manages task queues, runs 24/7, ships working code."

readme = "README.md"
Expand Down