# Codens Help — Documentation Portal

> Multi-page documentation portal for the Codens family (Purple,
> Red, Blue, Green, Yellow, Auth). Covers account setup, MCP
> integration, per-product initial setup, the full 38-tool action-
> dispatch catalog, error envelope, pricing, and troubleshooting.

The Codens family consists of Purple (orchestration), Red (auto-repair),
Blue (QA automation), Green (PRD / Plan / Kickoff), Yellow (engineering
ledger), and Auth Codens (unified OAuth2/OIDC). All products expose
tools through a single MCP server (`codens-mcp`) or via REST APIs at
api.{red,blue,green,purple,auth}.codens.ai.

Authentication is Device Code Flow (RFC 8628) at
https://auth.codens.ai/device. The canonical login path is the
`codens-mcp login` CLI; the token is stored at
`~/.purple-codens/credentials.json` (mode 0600) and shared across all
Codens services.

## Pages

- [Help Portal (top)](https://help.codens.ai/): Family overview and entry points to all sub-pages.
- [Getting Started](https://help.codens.ai/getting-started.html): Sign up on auth.codens.ai → create organization → choose products → install MCP → first project.
- [MCP Setup](https://help.codens.ai/setup-mcp.html): Install codens-mcp, register in settings.json (Claude Code / Cursor / Cline), Device Code Flow login, REST API alternative.

### Per-product setup

- [Purple Codens](https://help.codens.ai/purple.html): Project creation, GitHub repo link, CLAUDE.md / rules instruction sync, first workflow run, operations notes.
- [Red Codens](https://help.codens.ai/red.html): Project creation, GitHub App, Sentry webhook configuration, first bug → fix plan → Purple submission.
- [Blue Codens](https://help.codens.ai/blue.html): Project creation, test environment registration, first E2E test generation and execution.
- [Green Codens](https://help.codens.ai/green.html): Project creation, Notion link, Consultation → PRD → Plan → Purple flow, Kickoff wizard.
- [Auth Codens](https://help.codens.ai/auth.html): Sign up, organization & member management, SSO, API key / agent capability tokens, useful endpoints.

### Reference

- [Use cases](https://help.codens.ai/usecases.html): The four canonical agent conversations — Purple, Red→Purple, Blue, Green→Purple.
- [All 38 tools](https://help.codens.ai/tools.html): Action-dispatch catalog grouped by service (Purple 7 / Red 4 / Blue 1 / Green 24 / Auth 1 / Cross 1).
- [Error envelope](https://help.codens.ai/errors.html): `{detail, error_code, category, retry_after_seconds, suggested_action}` plus the main `error_code` enum.
- [Pricing](https://help.codens.ai/pricing.html): 1 credit = ¥0.01, 5 monthly tiers (Free Trial / Hobby / Pro / Business / Enterprise), machine-readable JSON.
- [Troubleshooting](https://help.codens.ai/troubleshooting.html): expired_token, UNAUTHORIZED, cross-service org_id, pending runs, Notion sync, Sentry signing.

## Login (Device Code Flow)

- [Authorization page](https://auth.codens.ai/device): Where users paste the `user_code` shown by `codens-mcp login`.
- [codens-mcp CLI](https://pypi.org/project/codens-mcp/): Run `codens-mcp login` from a terminal. The token is saved to `~/.purple-codens/credentials.json` (mode 0600) and shared by every Codens service. If a CLI isn't available, call `purple_auth(action="login", use_device_code=true)` from the agent — but the CLI is more reliable.

## Tools (38 total, action-dispatch)

The 2026-05-18 refactor (PR #1065) collapsed 181 fine-grained tools into 38 action-dispatch tools. Every tool takes an `action: Literal[...]` parameter that selects the actual operation.

- Purple (7): `purple_auth`, `purple_project`, `purple_repository`, `purple_instruction`, `purple_workflow`, `purple_sse`, `purple_log`.
- Red (4): `red_bug_report`, `red_bug_fix_plan`, `red_fix_proposal`, `red_external_task`.
- Blue (1): `blue_e2e_test` (actions: list / generate / run / get_results).
- Green (24): `green_consultation`, `green_prd`, `green_prd_ai`, `green_prd_template`, `green_prd_comment`, `green_prd_review`, `green_prd_attachment`, `green_prd_translate`, `green_plan`, `green_plan_task`, `green_plan_monitoring`, `green_task`, `green_project`, `green_repository`, `green_organization`, `green_knowledge`, `green_notion`, `green_kickoff`, `green_kickoff_wizard`, `green_kickoff_generate`, `green_kickoff_refine`, `green_kickoff_prototype`, `green_kickoff_preview`, `green_kickoff_mockup`.
- Auth (1): `auth_agent` (actions: signup / get_pricing).
- Cross-product (1): `codens_register_project_unified`.

## Languages

- Japanese (default): https://help.codens.ai/{page}.html (13 pages)
- English: https://help.codens.ai/en/{page}.html (13 pages — full mirror)

## Optional Full Reference

- [llms-full.txt](https://help.codens.ai/llms-full.txt): Full plain-text dump of every help page for ingestion into LLM context windows.