Project tools

Six tools for the project — the unit that owns pages, journeys, audits, and tickets.

list_projects

List projects in an organization.

Name	Type	Required	Notes
organization_id	string	yes
first	number	no	Page size. Default 20.
after	string	no	Opaque cursor from a prior page’s endCursor.

Returns: { totalCount, pageInfo, projects }. pageInfo carries hasNextPage and endCursor.

Returns an error block if your credential cannot reach that organization.

get_project

Get a single project by ID with details.

Name	Type	Required
project_id	string	yes

Returns: the project — id, name, description, domain, pageCount, plan, createdAt, updatedAt, its organization, and a pages total.

create_project

Create a new project in an organization.

Name	Type	Required	Notes
organization_id	string	yes
name	string	yes
domain	string	yes	e.g. https://example.com.
description	string	no
type	enum	no	Platform being audited. web | ios | android. Default web.
use_cases	enum[]	no	At least one of usability | ci | altText. Default ["usability"].

Both are required server-side; omit them and web / ["usability"] are sent. See Vocabularies.

Returns: the created project.

update_project

Update an existing project’s name, description, or domain.

Name	Type	Required
project_id	string	yes
organization_id	string	yes
name	string	no
description	string	no
domain	string	no

Only the fields you pass are changed. Omitting a field leaves it alone; it does not clear it.

Returns: the updated project.

delete_project

Delete a project. Requires the admin role.

Name	Type	Required
project_id	string	yes
organization_id	string	yes

Returns: the confirmation line Deleted project: <name>.

import_sitemap

Import pages from a sitemap URL into a project.

Name	Type	Required	Notes
project_id	string	yes
organization_id	string	yes
sitemap_url	string	yes	URL of the sitemap to import.

The crawl is asynchronous. The tool returns as soon as it is queued: Sitemap crawl started. Check the project's sitemap diff panel for results. — the imported pages appear in the dashboard’s sitemap diff panel, not in this response.

If the crawl is refused, the tool returns Failed to start sitemap crawl. without marking the result as an error, so check the text rather than assuming success.