# Harmony

> Agent-native Kanban where humans and AI stay in sync.

Harmony is a collaborative project management board built for AI agents. It provides an MCP server and REST API so your coding agent can manage cards, track progress, and collaborate with your team - all from the terminal.

## Onboarding (New Users)

If you don't have an account yet, follow these steps:

1. Sign up at https://gethmy.com/auth (email + password, minimum 6 characters)
2. First login auto-creates a workspace and a starter board with To Do / In Progress / Done columns
3. Go to https://gethmy.com/user/keys → click "Generate New Key" → copy the key (starts with `hmy_`, shown only once)

### Non-Interactive Setup

Once you have your API key, run this single command - no prompts, no interaction:

```
npx harmony-mcp setup --api-key <KEY> --global
```

## Quick Setup

Prerequisites: A Harmony account at https://gethmy.com

1. Get an API key: https://gethmy.com/user/keys (click "Generate New Key")
2. Run setup:

```
npx harmony-mcp setup
```

The wizard validates your key, detects your AI agent, and configures everything automatically.

## Supported Agents

- Claude Code - workflow: `/hmy #42`
- OpenAI Codex - workflow: `/prompts:hmy #42`
- Cursor - MCP tools auto-available
- Windsurf - MCP tools auto-available

## What You Can Do

- Create, update, move, and delete cards
- Manage columns, labels, and subtasks
- Link cards (blocks, relates_to, duplicates, is_part_of)
- Track agent work sessions with progress updates
- Generate AI-ready prompts from cards
- Process natural language commands
- Full REST API access with API key auth

## Card Workflow

Start work on a card (e.g., `/hmy #42`):
Find card → Move to "In Progress" → Add "agent" label → Start session → Implement → Move to "Review"

## More Information

- Full documentation: https://gethmy.com/llms-full.txt
- MCP package: https://www.npmjs.com/package/harmony-mcp
- Website: https://gethmy.com