Capture GTD exposes two MCP tools — read-gtd and write-gtd — that give AI assistants full access to your GTD system. Both tools use a discriminated-union JSON schema: a top-level organizationId and a query or command object whose type field selects the operation.
Connection Details
| Property | Value |
|---|---|
| Server URL | https://app.capture-gtd.com/mcp |
| Transport | Streamable HTTP (MCP spec 2025-11-25) |
| Authentication | OAuth 2.0 with scopes openid and offline_access |
All requests require an organizationId (UUID). The authenticated user must be a member of the specified organization.
read-gtd
Query GTD data. Read-only; does not modify state.
Top-level parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
organizationId | string (UUID) | Yes | The organization to query |
query | object | Yes | The query object; must include a type field |
Returns: JSON-serialized query results as text content.
Task Queries
inbox
Retrieve all unclarified inbox items (tasks with kind Stuff).
| Parameter | Type | Required |
|---|---|---|
type | "inbox" | Yes |
nextTasks
Retrieve all active next actions (Todos), sorted by impact score.
| Parameter | Type | Required |
|---|---|---|
type | "nextTasks" | Yes |
engagedTasks
Retrieve prioritized actionable tasks, optionally filtered by context or project.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "engagedTasks" | Yes | |
context | string (UUID) | No | Filter by context ID |
project | string (UUID) | No | Filter by project ID |
getTask
Retrieve full details for a single task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getTask" | Yes | |
taskId | string (UUID) | Yes | The task ID |
allTasks
Retrieve all tasks in the system.
| Parameter | Type | Required |
|---|---|---|
type | "allTasks" | Yes |
completedTasks
Retrieve all completed tasks.
| Parameter | Type | Required |
|---|---|---|
type | "completedTasks" | Yes |
tasksCompletedBetween
Retrieve tasks completed within a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "tasksCompletedBetween" | Yes | |
startInclusive | string (date-time) | Yes | Range start (inclusive) |
endExclusive | string (date-time) | Yes | Range end (exclusive) |
tasksDueOnOrBefore
Retrieve tasks with deadlines on or before a given date.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "tasksDueOnOrBefore" | Yes | |
date | string (date-time) | Yes | The cutoff date |
doneOnDate
Retrieve tasks completed on a specific date.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "doneOnDate" | Yes | |
date | string (date-time) | Yes | The date |
trashed
Retrieve all trashed tasks.
| Parameter | Type | Required |
|---|---|---|
type | "trashed" | Yes |
waitingFor
Retrieve all Waiting For tasks.
| Parameter | Type | Required |
|---|---|---|
type | "waitingFor" | Yes |
Project Queries
projects
Retrieve all active projects.
| Parameter | Type | Required |
|---|---|---|
type | "projects" | Yes |
allProjects
Retrieve all projects (including completed).
| Parameter | Type | Required |
|---|---|---|
type | "allProjects" | Yes |
inProject
Retrieve all tasks belonging to a project.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "inProject" | Yes | |
projectId | string (UUID) | Yes | The project ID |
subProjects
Retrieve sub-projects of a project.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "subProjects" | Yes | |
projectId | string (UUID) | Yes | The parent project ID |
projectsWithoutNextActions
Retrieve projects that have no active next action (stuck projects).
| Parameter | Type | Required |
|---|---|---|
type | "projectsWithoutNextActions" | Yes |
staleProjects
Retrieve projects with no activity since a threshold date.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "staleProjects" | Yes | |
activityThreshold | string (date-time) | Yes | No activity since this date |
blockedTasksInProject
Retrieve tasks in a project that are blocked by unresolved dependencies.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "blockedTasksInProject" | Yes | |
projectId | string (UUID) | Yes | The project ID |
dependencyGraph
Retrieve the dependency graph for a task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "dependencyGraph" | Yes | |
taskId | string (UUID) | Yes | The root task ID |
Schedule Queries
scheduled
Retrieve all scheduled (calendar) items.
| Parameter | Type | Required |
|---|---|---|
type | "scheduled" | Yes |
scheduledBefore
Retrieve scheduled items before a given date.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "scheduledBefore" | Yes | |
date | string (date-time) | Yes | The cutoff date |
tasksScheduledBetween
Retrieve tasks scheduled within a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "tasksScheduledBetween" | Yes | |
startInclusive | string (date-time) | Yes | Range start (inclusive) |
endExclusive | string (date-time) | Yes | Range end (exclusive) |
List Queries
somedayMaybe
Retrieve all Someday/Maybe items.
| Parameter | Type | Required |
|---|---|---|
type | "somedayMaybe" | Yes |
referenceFiles
Retrieve all Reference items.
| Parameter | Type | Required |
|---|---|---|
type | "referenceFiles" | Yes |
auditLog
Retrieve the audit log of all events.
| Parameter | Type | Required |
|---|---|---|
type | "auditLog" | Yes |
Organization Queries
allContexts
Retrieve all contexts.
| Parameter | Type | Required |
|---|---|---|
type | "allContexts" | Yes |
getContext
Retrieve a single context by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getContext" | Yes | |
contextId | string (UUID) | Yes | The context ID |
allAreasOfFocus
Retrieve all areas of focus.
| Parameter | Type | Required |
|---|---|---|
type | "allAreasOfFocus" | Yes |
getAreaOfFocus
Retrieve a single area of focus by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getAreaOfFocus" | Yes | |
areaId | string (UUID) | Yes | The area of focus ID |
allPeople
Retrieve all people (for delegation/Waiting For).
| Parameter | Type | Required |
|---|---|---|
type | "allPeople" | Yes |
getPerson
Retrieve a single person by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getPerson" | Yes | |
personId | string (UUID) | Yes | The person ID |
Horizons Queries
activeGoals
Retrieve all active goals (Horizon 3).
| Parameter | Type | Required |
|---|---|---|
type | "activeGoals" | Yes |
allGoals
Retrieve all goals (including completed).
| Parameter | Type | Required |
|---|---|---|
type | "allGoals" | Yes |
getGoal
Retrieve a single goal by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getGoal" | Yes | |
goalId | string (UUID) | Yes | The goal ID |
goalsByAreaOfFocus
Retrieve goals linked to an area of focus.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "goalsByAreaOfFocus" | Yes | |
areaOfFocusId | string (UUID) | Yes | The area of focus ID |
goalsByVision
Retrieve goals linked to a vision.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "goalsByVision" | Yes | |
visionId | string (UUID) | Yes | The vision ID |
goalsWithUpcomingTargetDates
Retrieve goals with target dates within a given number of months.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "goalsWithUpcomingTargetDates" | Yes | |
withinMonths | integer | Yes | Number of months ahead |
activeVisions
Retrieve all active visions (Horizon 4).
| Parameter | Type | Required |
|---|---|---|
type | "activeVisions" | Yes |
allVisions
Retrieve all visions (including completed).
| Parameter | Type | Required |
|---|---|---|
type | "allVisions" | Yes |
getVision
Retrieve a single vision by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getVision" | Yes | |
visionId | string (UUID) | Yes | The vision ID |
visionsByAreaOfFocus
Retrieve visions linked to an area of focus.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "visionsByAreaOfFocus" | Yes | |
areaOfFocusId | string (UUID) | Yes | The area of focus ID |
getPurposeAndPrinciples
Retrieve the purpose statement and principles (Horizon 5).
| Parameter | Type | Required |
|---|---|---|
type | "getPurposeAndPrinciples" | Yes |
Habits Queries
getRecurringTasks
Retrieve all recurring tasks (scheduled or deadline-based recurrences).
| Parameter | Type | Required |
|---|---|---|
type | "getRecurringTasks" | Yes |
getRecurringTaskAnalytics
Retrieve completion analytics for a recurring task over a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getRecurringTaskAnalytics" | Yes | |
taskId | string (UUID) | Yes | The recurring task ID |
startDate | string (date-time) | Yes | Range start |
endDate | string (date-time) | Yes | Range end |
getHabitsOverview
Retrieve a summary of habit completion rates over a date range.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getHabitsOverview" | Yes | |
startDate | string (date-time) | Yes | Range start |
endDate | string (date-time) | Yes | Range end |
getHabitsHeatmap
Retrieve a day-by-day heatmap of habit completions.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getHabitsHeatmap" | Yes | |
startDate | string (date-time) | Yes | Range start |
endDate | string (date-time) | Yes | Range end |
getHabitsTrend
Retrieve habit completion trend data at a given granularity.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "getHabitsTrend" | Yes | |
startDate | string (date-time) | Yes | Range start |
endDate | string (date-time) | Yes | Range end |
granularity | string | Yes | One of DAILY, WEEKLY, MONTHLY |
write-gtd
Execute GTD commands. Modifies state.
Top-level parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
organizationId | string (UUID) | Yes | The organization to modify |
command | object | Yes | The command object; must include a type field |
For creation commands (CaptureTask, CreateContext, CreateAreaOfFocus, CreateGoal, CreatePerson, CreateVision), the server generates the aggregate ID automatically. All other commands require an aggregateId field identifying the entity to modify.
Returns: JSON-serialized command result as text content.
Capture Commands
CaptureTask
Add a new item to the inbox.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CaptureTask" | Yes | |
name | string | Yes | Task title |
description | string | Yes | Task description |
importance | string | Yes | ExtraLow, Low, Medium, High, or Critical |
project | string (UUID) | No | Parent project ID |
{
"organizationId": "...",
"command": {
"type": "CaptureTask",
"name": "Call dentist to schedule cleaning",
"description": "",
"importance": "Medium"
}
}Clarify Commands
ClarifyTask
Clarify an inbox item by assigning it a GTD type. The nextState object uses a type discriminator to select the target kind.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ClarifyTask" | Yes | |
aggregateId | string (UUID) | Yes | Task to clarify |
nextState | object | Yes | Target kind (see variants below) |
name | string | No | Updated task name |
description | string | No | Updated description |
importance | string | No | ExtraLow, Low, Medium, High, or Critical |
projectId | string (UUID) | No | Assign to project |
contexts | string | No | Comma-separated context IDs |
areasOfFocus | string | No | Comma-separated area of focus IDs |
nextState variants:
Todo (Next Action):
| Field | Type | Required | Description |
|---|---|---|---|
type | "Todo" | Yes | |
effort | string | Yes | XSmall, Small, Medium, Large, or XLarge |
dependsOn | array of UUID | Yes | Task IDs this depends on (empty array if none) |
deadline | object | No | Deadline object (see Deadline below) |
Project:
| Field | Type | Required | Description |
|---|---|---|---|
type | "Project" | Yes | |
outcome | string | Yes | What “done” looks like |
effort | string | Yes | Effort estimate |
dependsOn | array of UUID | Yes | Dependency task IDs |
deadline | object | No | Deadline object |
goalId | string (UUID) | No | Link to a goal |
Scheduled (Calendar item):
| Field | Type | Required | Description |
|---|---|---|---|
type | "Scheduled" | Yes | |
effort | string | Yes | Effort estimate |
schedule | object | Yes | Schedule object (see Schedule below) |
SomedayMaybe:
| Field | Type | Required | Description |
|---|---|---|---|
type | "SomedayMaybe" | Yes | |
effort | string | Yes | Effort estimate |
dependsOn | array of UUID | Yes | Dependency task IDs |
ReferenceFile:
| Field | Type | Required |
|---|---|---|
type | "ReferenceFile" | Yes |
WaitingFor (Delegated):
| Field | Type | Required | Description |
|---|---|---|---|
type | "WaitingFor" | Yes | |
personId | string (UUID) | Yes | The person responsible |
effort | string | Yes | Effort estimate |
dependsOn | array of UUID | Yes | Dependency task IDs |
deadline | object | No | Deadline object |
{
"organizationId": "...",
"command": {
"type": "ClarifyTask",
"aggregateId": "...",
"nextState": {
"type": "Todo",
"effort": "Small",
"dependsOn": []
},
"importance": "High"
}
}MoveTask
Move a clarified task to a different GTD kind. Accepts the same nextState variants as ClarifyTask.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "MoveTask" | Yes | |
aggregateId | string (UUID) | Yes | Task to move |
nextState | object | Yes | Target kind |
DelegateTask
Delegate a task to another person (converts to Waiting For).
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DelegateTask" | Yes | |
aggregateId | string (UUID) | Yes | Task to delegate |
personId | string (UUID) | Yes | Person to delegate to |
Organize Commands
AddContextToTask / RemoveContextFromTask
Add or remove a context from a task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "AddContextToTask" or "RemoveContextFromTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
contextId | string (UUID) | Yes | Context ID |
AddAreaOfFocusToTask / RemoveAreaOfFocusFromTask
Add or remove an area of focus from a task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "AddAreaOfFocusToTask" or "RemoveAreaOfFocusFromTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
areaOfFocusId | string (UUID) | Yes | Area of focus ID |
AddDependency / RemoveDependency
Add or remove a dependency between tasks.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "AddDependency" or "RemoveDependency" | Yes | |
aggregateId | string (UUID) | Yes | Dependent task ID |
dependencyId | string (UUID) | Yes | Dependency task ID |
resolved | boolean | Yes (Add only) | Whether the dependency is already resolved |
AddProjectToGoal / RemoveProjectFromGoal
Link or unlink a project from a goal.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "AddProjectToGoal" or "RemoveProjectFromGoal" | Yes | |
aggregateId | string (UUID) | Yes | Project task ID |
goalId | string (UUID) | Yes (Add only) | Goal ID |
ReplaceTaskName
Change a task’s title.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskName" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
name | string | Yes | New name |
ReplaceTaskDescription
Change a task’s description.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskDescription" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
description | string | Yes | New description |
ReplaceTaskImportance
Change a task’s importance level.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskImportance" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
importance | string | Yes | ExtraLow, Low, Medium, High, or Critical |
ReplaceTaskEffort
Change a task’s effort estimate.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskEffort" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
effort | string | Yes | XSmall, Small, Medium, Large, or XLarge |
ReplaceTaskOutcome
Change a project’s outcome statement.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskOutcome" | Yes | |
aggregateId | string (UUID) | Yes | Project task ID |
outcome | string | Yes | New outcome |
ReplaceTaskProject
Change which project a task belongs to.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskProject" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
projectId | string (UUID) | No | New project ID (omit to unassign) |
ReplaceTaskDeadline
Change or remove a task’s deadline.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskDeadline" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
deadlineChange | object | Yes | Deadline change object |
deadlineChange variants:
| Variant | Fields | Description |
|---|---|---|
None | type: "None" | Remove the deadline |
Once | type: "Once", due: date-time | One-time deadline |
RecurrenceRule | type: "RecurrenceRule", rrule: string, start?: date-time | Recurring deadline (iCalendar RRULE) |
ReplaceTaskSchedule
Change a scheduled task’s schedule.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskSchedule" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
schedule | object | Yes | Schedule object |
ReplaceTaskWaitingForPerson
Change who a Waiting For task is delegated to.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplaceTaskWaitingForPerson" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
personId | string (UUID) | Yes | New person ID |
Engage Commands
CompleteTask
Mark a task as complete.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CompleteTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
occurrenceDate | string (date-time) | No | For recurring tasks, the specific occurrence date |
ReopenTask
Reopen a completed task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReopenTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
UncompleteRecurrence
Undo a specific occurrence completion on a recurring task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "UncompleteRecurrence" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
occurrenceDate | string (date-time) | Yes | The occurrence to uncomplete |
TrashTask
Move a task to the trash.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "TrashTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
RestoreTask
Restore a trashed task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "RestoreTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
DeleteTask
Permanently delete a task.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DeleteTask" | Yes | |
aggregateId | string (UUID) | Yes | Task ID |
Context Commands
CreateContext
Create a new context.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CreateContext" | Yes | |
name | string | Yes | Context name (e.g., @computer, @errands) |
UpdateContext
Rename a context.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "UpdateContext" | Yes | |
aggregateId | string (UUID) | Yes | Context ID |
name | string | Yes | New name |
DeleteContext
Delete a context.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DeleteContext" | Yes | |
aggregateId | string (UUID) | Yes | Context ID |
Area of Focus Commands
CreateAreaOfFocus
Create a new area of focus.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CreateAreaOfFocus" | Yes | |
name | string | Yes | Area name (e.g., Health, Career) |
UpdateAreaOfFocus
Rename an area of focus.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "UpdateAreaOfFocus" | Yes | |
aggregateId | string (UUID) | Yes | Area of focus ID |
name | string | Yes | New name |
DeleteAreaOfFocus
Delete an area of focus.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DeleteAreaOfFocus" | Yes | |
aggregateId | string (UUID) | Yes | Area of focus ID |
Person Commands
CreatePerson
Create a new person (for delegation/Waiting For).
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CreatePerson" | Yes | |
name | string | Yes | Person’s name |
email | string | No | Person’s email |
UpdatePerson
Update a person’s details.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "UpdatePerson" | Yes | |
aggregateId | string (UUID) | Yes | Person ID |
name | string | No | Updated name |
email | string | No | Updated email |
DeletePerson
Delete a person.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DeletePerson" | Yes | |
aggregateId | string (UUID) | Yes | Person ID |
Goal Commands (Horizon 3)
CreateGoal
Create a new goal.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CreateGoal" | Yes | |
name | string | Yes | Goal name |
description | string | No | Goal description |
UpdateGoal
Update a goal’s name or description.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "UpdateGoal" | Yes | |
aggregateId | string (UUID) | Yes | Goal ID |
name | string | No | Updated name |
description | string | No | Updated description |
CompleteGoal
Mark a goal as complete.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CompleteGoal" | Yes | |
aggregateId | string (UUID) | Yes | Goal ID |
ReopenGoal
Reopen a completed goal.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReopenGoal" | Yes | |
aggregateId | string (UUID) | Yes | Goal ID |
DeleteGoal
Delete a goal.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DeleteGoal" | Yes | |
aggregateId | string (UUID) | Yes | Goal ID |
Vision Commands (Horizon 4)
CreateVision
Create a new vision.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CreateVision" | Yes | |
name | string | Yes | Vision name |
description | string | No | Vision description |
UpdateVision
Update a vision’s name or description.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "UpdateVision" | Yes | |
aggregateId | string (UUID) | Yes | Vision ID |
name | string | No | Updated name |
description | string | No | Updated description |
CompleteVision
Mark a vision as complete.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "CompleteVision" | Yes | |
aggregateId | string (UUID) | Yes | Vision ID |
ReopenVision
Reopen a completed vision.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReopenVision" | Yes | |
aggregateId | string (UUID) | Yes | Vision ID |
DeleteVision
Delete a vision.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "DeleteVision" | Yes | |
aggregateId | string (UUID) | Yes | Vision ID |
Purpose & Principles Commands (Horizon 5)
ReplacePurposeStatement
Set or replace the purpose statement.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplacePurposeStatement" | Yes | |
aggregateId | string (UUID) | Yes | Purpose and principles aggregate ID |
statement | string | No | New purpose statement |
AddToPrinciples
Add a principle.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "AddToPrinciples" | Yes | |
aggregateId | string (UUID) | Yes | Purpose and principles aggregate ID |
principle | string | Yes | Principle text |
RemoveFromPrinciples
Remove a principle.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "RemoveFromPrinciples" | Yes | |
aggregateId | string (UUID) | Yes | Purpose and principles aggregate ID |
principle | string | Yes | Principle text to remove |
ReplacePrinciple
Replace the text of an existing principle.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | "ReplacePrinciple" | Yes | |
aggregateId | string (UUID) | Yes | Purpose and principles aggregate ID |
oldPrinciple | string | Yes | Existing principle text |
newPrinciple | string | Yes | Replacement text |
Shared Types
Deadline
Used by ClarifyTask, MoveTask, and ReplaceTaskDeadline.
| Variant | Fields | Description |
|---|---|---|
Once | type: "Once", due: string (date-time) | One-time deadline |
RecurrenceRule | type: "RecurrenceRule", rrule: string | Recurring deadline (iCalendar RRULE format) |
Schedule
Used by ClarifyTask (Scheduled kind), MoveTask, and ReplaceTaskSchedule.
| Variant | Fields | Description |
|---|---|---|
Once | type: "Once", scheduleDate: string (date-time) | One-time calendar event |
RecurrenceRule | type: "RecurrenceRule", rrule: string | Recurring event (iCalendar RRULE format) |
Effort
Enum values: XSmall, Small, Medium, Large, XLarge.
Importance
Enum values: ExtraLow, Low, Medium, High, Critical.