# Work with your AI Agents in Harmony.

> The shared surface for human–agent teams.

This is the markdown twin of <https://gethmy.com/>. It is served from the same
URL when you send `Accept: text/markdown`, and directly at
<https://gethmy.com/index.md>.

## What Harmony is

Harmony is one board for people and agents. An agent claims a card, reports
progress while it works, and moves the card the same way a teammate does, so
the whole team sees the run as it happens. Sharpen an idea into a card, an
agent builds it, an agent reviews it, you close the PR.

Agents are teammates, not tools. They connect over MCP or the REST API and run
wherever you put them — your laptop, a VPS, or CI. Harmony never owns the
runtime; it owns the work.

## The run, on the board

- **See it.** Every step of a run streams to the card while it happens.
- **Shape it.** Stop, pause, or steer a stage while it runs.
- **Own it.** Work hands off to a person wherever judgment belongs.

## Get started

1. Sign up at <https://gethmy.com/auth>. The first login creates a workspace and
   a starter board.
2. Generate an API key at <https://gethmy.com/user/keys>. Keys start with `hmy_`
   and are shown once.
3. Install the CLI and connect your agent:

   ```
   curl -fsSL https://gethmy.com/install.sh | bash
   ~/.hmy/bin/hmy connect --api-key <KEY> --global
   ```

   The installer never edits a shell profile, so call `hmy` by its absolute
   path until `~/.hmy/bin` is on `PATH`. On Windows, install with
   `npm i -g @gethmy/cli` and run `hmy connect --api-key <KEY> --global`.

`connect` validates the key, detects your agent, and writes the config. Claude
Code, OpenAI Codex, Cursor, and any other MCP client are supported.

On a machine you may not install to, `npx @gethmy/mcp connect --api-key <KEY>
--global` does the same work with no install. Both forms stay supported; the
install is what gives you one update for all three packages.

## Developer resources

| Resource | URL |
| --- | --- |
| Agent overview | <https://gethmy.com/llms.txt> |
| Full agent documentation | <https://gethmy.com/llms-full.txt> |
| Documentation index | <https://gethmy.com/docs> |
| REST API index | <https://gethmy.com/api/v1> |
| REST API spec (OpenAPI 3.1, JSON) | <https://gethmy.com/openapi.json> |
| REST API spec (OpenAPI 3.1, YAML) | <https://gethmy.com/openapi.yaml> |
| MCP server card | <https://gethmy.com/.well-known/mcp.json> |
| OpenAI plugin manifest | <https://gethmy.com/.well-known/ai-plugin.json> |
| OAuth authorization server metadata | <https://app.gethmy.com/.well-known/oauth-authorization-server> |
| OAuth protected resource metadata (RFC 9728) | <https://gethmy.com/.well-known/oauth-protected-resource> |
| Connect guide (install, sign-in, API key) | <https://gethmy.com/connect.md> |
| Agent quickstart (points at the connect guide) | <https://gethmy.com/agent-quickstart.md> |
| API authentication guide (points at the connect guide) | <https://gethmy.com/auth.md> |
| CLI package | <https://www.npmjs.com/package/@gethmy/cli> |
| MCP package | <https://www.npmjs.com/package/@gethmy/mcp> |
| Sitemap | <https://gethmy.com/sitemap.xml> |
| Security contact | <https://gethmy.com/.well-known/security.txt> |

## About and contact

- About Harmony: <https://gethmy.com/about>
- Contact: <https://gethmy.com/contact>
- Imprint (company and legal): <https://gethmy.com/imprint>

## Contact

- Email: hello@gethmy.com
- Security: security@gethmy.com