READ

list_components

Paginated list of the components a project is made of, with how many environments run each, narrowed by kind, search words or archived state.

Return the components of one project in the project's order: the web app, the API, the mobile apps, the services and the platform, each with its slug (what a version string names it by, as in web@1.4.0), its kind, its tech_stack tags, its owner_id and environments_count. Read it before writing code for a project, so you know which application a story touches and what it is built with, and to find the component_id an environment or a story names.

Narrow with kind (web_app, api, mobile_ios, mobile_android, mobile_cross_platform, desktop, service, integration, database, infrastructure, other), search (words in the name or the slug) and archived (true for archived components only, false for live ones; omit for both).

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

Arguments

project_id*string

UUID of the project whose components to list.

kindstringoptional

Narrow to one kind.

web_appapimobile_iosmobile_androidmobile_cross_platformdesktopserviceintegrationdatabaseinfrastructureother
searchstringoptional

Words the name or the slug must contain.

archivedbooleanoptional

`true` lists archived components only, `false` live ones only; omit for both.

limitintegeroptional

Components per page (1..100, default 25).

min1max100
pageintegeroptional

1-indexed page number.

min1

What it returns

{  "data": [    {      "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "name": "Customer Web App",      "slug": "web",      "kind": "web_app",      "description": "<p>The portal account holders sign in to.</p>",      "tech_stack": ["Laravel 13", "Livewire 4", "PostgreSQL 18"],      "owner_id": "5e0c7a2d-9b1f-4c3e-8d6a-2f4b7c9e1a30",      "position": 0,      "environments_count": 3,      "archived_at": null,      "created_at": "2026-10-20T09:00:00+00:00",      "updated_at": "2026-10-27T11:25:00+00:00"    }  ],  "meta": {    "page": 1,    "limit": 25,    "total": 1,    "has_more": false  }}

How it fails

VALIDATION_FAILED

kind is not one of the eleven kinds.

RESOURCE_NOT_FOUND

unknown project_id, or a project outside the token's scope or the person's visibility.

TOKEN_MISSING_ABILITY

token lacks component:view-any.

How is this guide?

Last updated on