Get a project, or the settings
get_projectRead one project in full, or with no project_id the settings any project can take. Read a project before update_project to see its current values. Read the settings before create_project, update_project or any config argument: keys are exact, and a guessed name is refused. list_projects is the lighter way to find a project. Inputs: project_id is the hex id from list_projects, not a name or URL. An unknown id answers 404. Webhooks: a project's answer includes its webhook URL, the events sent there, and the last 10 deliveries with their status and error, to see whether the endpoint is receiving them. update_project sets them and sends a test. Secrets: the webhook signing secret is never returned, and chat_url comes back masked. Read-only and free: it reads stored data and never fetches.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_project"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | No | The project's 32-character hex id, from list_projects; omit for the settings reference. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The project's 32-character hex id. | |
| code | No | Only on a failure: a machine-readable reason, e.g. read_only, validation, plan_limit or not_found. | |
| host | No | The site it covers; fixed at creation. | |
| name | No | Its display name. | |
| note | No | No project_id only: how path globs work. | |
| seed | No | Where its crawls start. | |
| error | No | Only when the call failed: what went wrong, in words an assistant can act on. | |
| pages | No | Pages its last finished run read, a number. | |
| config | No | Its settings as {key: value}; secrets such as chat_url come back masked. create_project and update_project list only the settings that differ from the defaults; get_project lists them all. | |
| detail | No | Only on a failure: the API's own wording, when the error was rephrased. | |
| status | No | draft, crawling, healthy or failing. On an error, the HTTP status code. | |
| purgeAt | No | When an archived project is deleted for good (ISO 8601), or null. | |
| archived | No | true for an archived project: it runs no more and is deleted on purgeAt unless restored. | |
| coverage | No | Percent of the site the last run reached; under 90 means removals are withheld. | |
| settings | No | No project_id only: every common setting as {key, meaning, default}. | |
| webhooks | No | get_project only: {url, events, deliveries}: where run and change events are POSTed, which events, and the last 10 deliveries, each {id, event, status (queued, retrying, delivered or failed), attempts, lastStatus, lastError, createdAt, deliveredAt}. The signing secret is never included. | |
| lastRunAt | No | When the last run started (ISO 8601), or null. | |
| nextRunAt | No | When the schedule runs it next, or null for manual. | |
| retention | No | How long runs are kept, e.g. '90d'. | |
| schedules | No | No project_id only: the valid schedules. | |
| archivedAt | No | When it was archived (ISO 8601), or null. | |
| configNote | No | create_project and update_project only: says that config lists only the non-default settings. | |
| other_keys | No | No project_id only: further keys accepted but rarely needed. | |
| scheduleKey | No | manual, hourly, daily or weekly. | |
| webhookTest | No | update_project with test_webhook only: {queued, id} when a test run.finished message was queued, or {error, status} when the API refused it, e.g. with no webhook URL saved. | |
| changeSummary | No | The last compared run in words, e.g. '3 new · 2 changed · 0 removed'. |