Skip to content
This page was generated and translated with the assistance of AI. If you spot any inaccuracies, feel free to help improve it. Edit on GitHub

Project Management

A project lives inside a workspace and serves as the container for issues, sprints, labels, and governance proposals. Each project has a unique key (e.g., API, FRONT, OPS) that prefixes issue identifiers.

Creating a Project

Navigate to your workspace and click New Project:

FieldRequiredDescriptionExample
NameYesDisplay name"Backend API"
KeyYes2-5 character prefix for issues"API"
DescriptionNoProject summary"REST API and business logic"

The key must be unique within the workspace and determines issue identifiers: API-1, API-2, etc.

Project Dashboard

Each project provides:

  • Board -- Kanban view with drag-and-drop columns (Backlog, To Do, In Progress, Done).
  • Issues -- List view with filtering, sorting, and full-text search.
  • Sprints -- Sprint planning and cycle management. See Sprints.
  • Labels -- Project-scoped labels for categorization. See Labels.
  • Settings -- Project name, key, description, and member settings.

Issue Counts

The project overview shows issue counts by state:

StateDescription
BacklogIdeas and future work
To DoPlanned for the current cycle
In ProgressActively being worked on
DoneCompleted work

API Reference

bash
# List projects in a workspace
curl -H "Authorization: Bearer <token>" \
  http://localhost:8080/api/workspaces/<workspace_id>/projects

# Create a project
curl -X POST http://localhost:8080/api/workspaces/<workspace_id>/projects \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{"name": "Backend API", "key": "API"}'

# Get project with issue counts
curl -H "Authorization: Bearer <token>" \
  http://localhost:8080/api/workspaces/<workspace_id>/projects/<project_id>

MCP Tools

ToolParamsDescription
projects.list--List all projects in the workspace
projects.getproject_idGet project details with issue counts
projects.createkey, nameCreate a new project
projects.updateproject_idUpdate name or description
projects.deleteproject_idDelete a project

Next Steps

  • Issues -- Create and manage issues within projects
  • Members -- Manage project access through workspace roles

Released under the Apache-2.0 License.