DocsPacedMind documentation

Areas and projects

Reference for the area and project tools: list_areas, create_area, update_area, delete_area, list_projects, get_project, create_project, update_project, delete_project and reorder_tasks.

list_areas

Read-only. Allowed without asking.

Lists the areas, the top level of the planner. Each line has the name, id, key, color, the icon when the area has one (or its own picture for an area with a picture), and the number of projects and open tasks.

No parameters.

create_area

Changes data.

Adds an area. Its key, used in task keys such as WRK-12, is made from the name.

ParameterTypeRequiredDescription
namestringyesThe area's name.
colorstringnoA palette name or a hex color. Defaults to a palette color no other area uses.
iconstringnoOne of the icon names (listed below). Without one, the area shows a dot.

Returns the new area with its id and key, such as Created area Finance · id finance · key FNN · Olive.

update_area

Changes data.

Renames an area, or changes its color or icon. A new name gives the area the key made from it, which its new tasks get; existing task keys don't change.

ParameterTypeRequiredDescription
areastringyesThe area's id, name or key.
namestringnoThe new name.
colorstringnoA palette name or a hex color.
iconstringnoOne of the icon names, or none to show the area's dot again.

The icon names are Lucide's names for the icons the area menu offers, such as briefcase, house, graduation-cap, code, heart-pulse, plane, wallet and music. An unknown name returns an error that lists icons whose names or meanings match it.

An icon replaces the area's own picture. Pictures, such as a company logo, are chosen in the app only: see the area menu.

delete_area

Deletes. Agents ask the user first.

Deletes an area and its projects. Their tasks are kept and move to the Inbox.

ParameterTypeRequiredDescription
areastringyesThe area's id, name or key.

Returns what happened, such as Deleted area Learning. Deleted its projects: Spanish B1. 3 tasks moved to the Inbox.

list_projects

Read-only. Allowed without asking.

Lists the projects with their area, progress, target date, color, agent, folder and the project they start after.

ParameterTypeRequiredDescription
areastringnoOnly projects in this area.

Each line reads, for example: Q4 planning (id q4) · Work · 2 open of 3 · 33% done · target 2026-10-01 (Thu).

get_project

Read-only. Allowed without asking.

A project's details and its tasks in roadmap order, grouped by status (In review, In progress, Todo, Backlog), plus the next task that is ready to be worked on, as get_next_task finds it.

ParameterTypeRequiredDescription
projectstringyesThe project's id or name.
include_donebooleannoAlso list done and canceled tasks. Without it, the result only counts them.

create_project

Changes data.

Adds a project to an area.

ParameterTypeRequiredDescription
namestringyesThe project's name.
areastringyesThe area's id, name or key.
colorstringnoA palette name or a hex color. Without it, the project uses the area's color.
start_datedatenoDefaults to today.
target_datedatenoWhen it should be finished.
folderstringnoThe absolute path of the folder agent sessions work in. It must exist.
agentclaude or codexnoThe default agent for the project's tasks.
starts_afterstringnoAnother project that must be finished first.

Errors include Can't use the folder … with the reason, such as That folder doesn't exist.

update_project

Changes data.

Changes a project. Parameters left out keep their value; null clears a field.

ParameterTypeRequiredDescription
projectstringyesThe project's id or name.
namestringnoThe new name.
areastringnoMoves the project, and all its tasks, to this area.
colorstringnoA palette name, a hex color, or area to use the area's color again.
start_datedate or nullnoThe start date.
target_datedate or nullnoThe target date.
folderstring or nullnoThe absolute folder path for agent sessions.
agentclaude, codex or nullnoThe default agent.
starts_afterstring or nullnoA project that must be finished first, or null for none.

A project can't start after itself or after a project that waits for it: … can't start after …: they would wait for each other.

delete_project

Deletes. Agents ask the user first.

Deletes a project. Its tasks stay in the project's area without a project.

ParameterTypeRequiredDescription
projectstringyesThe project's id or name.

reorder_tasks

Changes data.

Sets the roadmap order of a project's tasks: the order shown in Roadmap and used by get_next_task.

ParameterTypeRequiredDescription
projectstringyesThe project's id or name.
orderstring listyesTask keys that should come first, in order. The other tasks keep their order after them.

Returns the new numbered order.

On this page