The Skill
Copy page
Embed this file in a repo so Claude Code, Codex, or other MCP agents follow Plan Desk conventions. plandesk connect writes the same content to .plandesk/skill.md and references it from CLAUDE.md.
Copy to your repo as .plandesk/skill.md or add to agent instructions. Keep it committed — no secrets.
Plan Desk MCP Instructions
Section titled “Plan Desk MCP Instructions”At the start of any session where Plan Desk may be used, list the available Plan Desk MCP tools before calling them. Do not assume tool names or parameter shapes; if expected tools are missing, say so before proceeding.
Never guess or hardcode a Plan Desk project, task, or document ID. Resolve the project as below; look up tasks/documents by name and use the returned ID.
New to this repo? Run plandesk onboard for the full Plan Desk + Factory model
(how the board works, the execution loop, delegation, and the MCP tools).
Resolving the project
Section titled “Resolving the project”- Read
.plandesk/config.json.- If
projectIdis present (v1 config), use it. Stop here — do not ask which project. - If
workspaceIdis present (v2 config), the repo is workspace-bound.list_projectsreturns only that workspace’s projects. Resolve the target project within the bound workspace. A project id outside the workspace is not found.
- If
- (Fallback, only if no config file) check conversation history for a named project; then the working-directory name for a close match; then an explicit name in the request.
- Single clear match → act directly. Multiple → show options and ask. None → say so and ask.
Standing up a plan
Section titled “Standing up a plan”When asked to plan a project, feature, or RFC from scratch, prefer the one-shot
scaffold_project_from_plan tool over many separate calls: it creates the
project, all tasks, their dependency edges, and linked spec documents in a
single atomic call. Give each task (and any document you need to reference) a
stable key (a slug you choose) and reference those keys in edges
(from/to) and in a document’s link_to (a single key or a list of
task and document keys). The server resolves keys to real IDs and returns a
key_to_id map covering both tasks and keyed documents.
scaffold_project_from_plan works for both a new and an existing project: omit
project_id and pass name to create a new one; pass project_id (e.g. the
repo-bound project from .plandesk/config.json) to scaffold the whole plan
atomically INTO that project. When the repo is already bound, pass
project_id — creating a new project duplicates the bound one. Reach for the
granular create_task/create_edge/create_document tools only for a
one-off single addition, not for standing up a whole plan.
Task creation
Section titled “Task creation”- Labels: short, imperative, outcome-focused — “Verb Noun in Location”. The label must make clear what “done” looks like.
- Status at creation:
todo(defined, ready) orscope(needs design/sizing). Never create a task asin_progress. - Build-contract depth. Non-trivial tasks are build contracts, not tickets —
a worker executes the task start-to-done without re-reading any parent RFC,
PRD, or ticket. The description REQUIRES:
- Problem — what must change; reference class/method names, never line numbers.
- Action Items — specific, independently completable steps.
- Interfaces — the concrete signatures/types/API/CLI surface this task introduces or touches, named exactly (function signatures, endpoint shapes, CLI flags, config keys).
- Pseudocode — control flow for any behavior that isn’t obvious from the interfaces alone. Skip only for a small, single-obvious-path edit.
- Validation contract — the specific test, command, or observable
outcome that proves this task done; align it to the parent Goal’s
verification_surfacewhen the task belongs to one. - References — linked documents or related tasks.
- Descriptions stay consumer-clean: no internal RFC/PRD/ticket references embedded in the text — link a Plan Desk document instead of citing an external ticket ID inline.
- Before creating, check for an existing task covering the same work; prefer updating/linking over duplicating.
- Creating several tasks: space ~200 units apart, group related, place blockers above what they block.
Documents
Section titled “Documents”- Write bodies as well-structured Markdown —
##headings, bullet lists, fenced code blocks, and blank lines between paragraphs. Bodies render as rich text in the UI; a wall of unbroken text is unreadable for people. - Title prefix:
Investigation:,Scope:,Design:,Decision:, orFix:.Design:proposes something to be built;Decision:records a call already made (context, what was chosen, what follows) and needs no build contract. - Include a
Status:line near the top: “Ready to implement”, “Open — requires investigation”, “Ready for review”, or “Superseded”. - A document can link to many tasks and to other documents. Prefer
link_toas a list (task and document keys or ids) rather than a single primary only;get_documentreturnslinksandbacklinksso related specs can be walked without a second query. - After creating a document, link it to every task it covers (and any parent or related specs) in the same step.
Notes are free-form working notes scoped to the project — findings, context, scratch reasoning, anything worth referring back to later. They are distinct from documents: notes are not linked to tasks, not nested, and not part of the formal plan or client share. Reach for a note when the content is for working memory rather than a deliverable spec.
list_notes(byproject_id) to see existing notes;get_noteto read one.create_noteto capture a new note (give it a cleartitle);update_noteto revise the title or body.- Write bodies as well-structured Markdown —
##headings, bullet lists, blank lines between paragraphs. Bodies render as rich text in the UI.
- Use
attach_fileto upload an image and get back{ file_id, url }; embed it in a document, task, or comment body asinstead of inlining base64 — keeps bodies lean.mimedefaults toimage/png.
- Connect related tasks and documents with labeled edges keyed on
from_type/from_id/to_type/to_id(taskordocument). Prefer the vocabulary:blocks,depends_on,unblocks,feeds,clarifies,enables,supports,documents,references,supersedes,extends. - When you discover a new dependency while working, add the edge.
Executing the plan
Section titled “Executing the plan”Follow .agents/factory/factory.md for the per-item contract (pull → red gate →
delegate → prove → gate → ship, with the agent-run lifecycle). The loop below is
the tool-level default it builds on.
To work a plan, do not guess what is next — call get_next_task. It returns the
next actionable todo task (one whose prerequisite tasks are all done), plus
the blocked tasks and what each is waiting_on. The loop:
get_next_task→ the next unblocked task.- Read its linked document before changing anything.
update_tasktoin_progress, do the work, thenupdate_tasktodone.- Repeat until
get_next_taskreports no actionable task.
Edge direction drives sequencing: from → to with most labels (blocks,
feeds, enables, …) means from finishes before to; depends_on reverses
it (from depends_on to ⇒ to first). Add edges so dependencies sequence right.
Track the moves within a task with the harness task tools — when a task needs more than one verifiable step, decompose it with TaskCreate / TaskList / TaskUpdate: one sub-task per move, in_progress when you start it, completed the moment its done-condition holds. The board decides what is next (durable, survives compaction via the F1 hooks); harness tasks are per-session scratchpad for the moves inside the current item — re-derive from the board after a compaction, never trust the harness list as the source of truth.
Keeping the board true
Section titled “Keeping the board true”The board is only useful when it matches reality. Two standing rules:
- Atomic status updates — flip a task’s status in the same step as the work
event it reflects, never in a batch at the end:
update_tasktoin_progressthe moment you start,donethe moment the work is verified, back totodo(orscope) if you stop without finishing. At any instant the board should show what is actually happening right now. - Reconcile against reality — at the start of a session, after any long
break, and before reporting a plan finished, sweep the whole board against
the actual state of the work: recent commits, the working tree, what is
verifiably built and shipped. Fix every mismatch with
update_task— work that is done but notdone, tasksin_progressthat nobody is working on, planned tasks the code shows are already built or obsolete. Note non-obvious corrections in the task description or a document comment so the drift and its fix are traceable.
Comments
Section titled “Comments”People leave comments on documents in the UI to give you feedback or direction.
- At the start of a session, and after finishing a task, pull open feedback with
list_comments(byproject_id, optionally onedocument_id). By default you get unresolved comments. - Address each comment, then
resolve_commentto close the loop — resolving updates the commenter’s UI live. - Use
add_commentto leave a suggestion or question on a document for a person. - People can also annotate files you wrote (not just workspace documents) — see
the next section. Pull those with
list_artifact_comments(byproject_id+artifact_id), address them, andresolve_commentthe same way.
Reviewing files (the CLI previewer)
Section titled “Reviewing files (the CLI previewer)”Beyond the workspace UI, a person can open any Markdown or HTML file you produced in a local previewer and annotate it:
plandesk <file.md> # or: plandesk *.md, plandesk open <paths...>They highlight text and attach notes. In a connected repo those annotations are
stored as artifact comments in this project’s board, so you read and resolve
them over MCP exactly like document comments — list_artifact_comments to pull,
resolve_comment to close. This closes the “you write a file → the human marks it
up → you fix it” loop on files, not just documents. When you finish a deliverable
file, tell the person they can review it with plandesk <that file>.
Artifacts
Section titled “Artifacts”An artifact is a stored agent deliverable — a report, an RFC, an HTML diagram — kept in the workspace (not a file on disk).
create_artifactto store one (title,content, optionalkind:markdownorhtml); the returnedartifact_idis exactly the idlist_artifact_comments/add_artifact_commentuse, so a human’s annotation and yourupdate_artifactrevision close the loop without a file on disk.get_artifactto read one back before revising;list_artifactsto check what a project already has before creating a duplicate.- Prefer an artifact over a Note or Document when the deliverable is a finished
piece meant to be read and marked up (a report, a spec, a diagram) rather than
tracked plan state.
artifact_idis opaque — pass through whatcreate_artifactorlist_artifact_commentsgave you, never construct it.
Sharing
Section titled “Sharing”create_share_linkhands a delegated worker or sub-agent full context for one task or document without giving it MCP access: pass exactly one oftask_id/document_id, get back{ url, markdown_url, expires_at }. PutContext: <markdown_url>in the worker’s brief instead of pasting context —markdown_urlreturns the resource as agent-ready Markdown with linked docs inlined and embedded images fetchable.expiresdefaults to24h; passneveronly when the link truly needs to outlive a session — it stays public to anyone who has it.
Agent runs
Section titled “Agent runs”- Start a run at the beginning of any multi-step Plan Desk operation.
- Record progress after each meaningful unit of work (not every tool call).
- Complete or fail the run before the session ends — never leave one open.
Never do
Section titled “Never do”The highest-consequence guardrails — each section above states the positive form; these are the ones worth a hard, consolidated reminder:
- Guess or hardcode IDs.
- Delete tasks, documents, notes, or artifacts — there is no delete tool by design; resolve, supersede, or set status instead.
- Batch status updates for the end of a session — statuses flip atomically as the work happens (see “Keeping the board true”).
- Inline large images as base64 in a document/task/comment body —
attach_fileand embed the returnedurlinstead.