Vigile
SearchContents

DocumentationOperations

set_project_status

Change a project's status: open, in_preview, ready, broken or cancelled. Any move to another status is allowed; setting the status the project already has is refused. Tasks that depend on the project wait until it is ready or cancelled. Marking a project ready while it holds unfinished tasks is allowed and shows up as a problem on the project.

The operation's own description: what an agent reads to decide whether and how to call it.
It
Changes the plan, as one step that is stored whole or not at all.
Who may call it
Every user.
Version
Takes the version the caller last read, and is refused with version_conflict when the item has changed since. A change moves the version one on. A call that asks for what is already so is refused with same_status.
Answers with
The project in short. Its fields: kind, id, title, status, version, progress, has_problems, and sometimes problems, deleted_at. Not in it: description, links, timeline, created_at, created_by, updated_at and unchanged_since. get has those.
MCP tool
set_project_status
HTTP
POST /api/set-project-status
Command
vigile set-project-status

Input

FieldTakesWhat it is
idstringrequiredThe project's ID.
versioninteger
1 or more
requiredThe version of the item you last read. The call fails with a conflict if the item changed since.
status"open" | "in_preview" | "ready" | "broken" | "cancelled"required

A field that is not listed here is refused, as invalid_input. On the command line each field is an option, with hyphens for underscores: --id.

Example

The same call three ways, as agent1. It was made on the demo plan the pictures of this site show. Over HTTP and MCP, a call without a key acts as agent1 on a new instance.

Command line

vigile set-project-status --id APP --version 1 --status in_preview --as agent1

HTTP

curl -s http://127.0.0.1:8700/api/set-project-status \
  -H 'content-type: application/json' \
  -d '{"id":"APP","version":1,"status":"in_preview"}'

MCP tool call

{
  "name": "set_project_status",
  "arguments": { "id": "APP", "version": 1, "status": "in_preview" }
}

The answer

{
  "kind": "project",
  "id": "APP",
  "title": "Mobile app",
  "status": "in_preview",
  "version": 2,
  "progress": { "finished": 1, "total": 3 },
  "has_problems": false
}

This is what a service answered when this page was built. Over HTTP it is the body of the response, over MCP the text of the tool result, and the command line prints it in words unless given --json.

What it answers

The project in short, with its new status and its version, one higher.

Rules

  • Any move between the statuses of a project is allowed, except to the status it already has.
  • Tasks that depend on the project wait until it is ready or cancelled.
  • Marking a project ready while it holds unfinished tasks is allowed, and shows as the problem ready_with_unfinished_tasks on the project.
  • A project that is broken says so as a problem, and so does every unfinished task that depends on it.
  • The change of status is added to the project's timeline and history.

Errors

  • version_conflict: the project changed since it was read. The error holds it as it is now, in short.
  • rule_violation: same_status, or deleted for a project that is deleted.
  • not_found: no project has that ID.