BytesMap
Operation reference

projects operations

MCP tools and operation permissions for projects.

Open Markdown

Generated from the shared operation catalog. Use the JSON catalog for complete input schemas. Required dependency checks can be stricter than the resource permission listed below.

project_list

List accessible projects and counts of dashboards, folders, queries, charts, actions and panels. Project grants apply to their saved items; individually shared items remain accessible without a project grant. Counts include only accessible items.

  • HTTP: GET /api/projects
  • SDK: client.projects.list(input)
  • Access: workspace
  • Effect annotation: Read-only

See the JSON schema for this input contract.

project_create

Create a project for related dashboards, folders, queries, charts, actions and panels. Does not create an organization, duplicate resources or execute data.

  • HTTP: POST /api/projects
  • SDK: client.projects.create(input)
  • Access: workspace; project / write
  • Effect annotation: May change state or run effects
InputRequirementDescription
nameRequiredstring
descriptionOptionalstring

project_update

Rename a project or update its description.

  • HTTP: PATCH /api/projects/:id
  • SDK: client.projects.update(input)
  • Access: workspace; project / write
  • Effect annotation: May change state or run effects
InputRequirementDescription
nameRequiredstring
descriptionOptionalstring
idRequiredstring

project_delete

Remove a project container. Its dashboards, folders, queries, charts, actions and panels become unassigned; definitions and references are retained. Project-inherited access ends; direct item grants remain.

  • HTTP: DELETE /api/projects/:id
  • SDK: client.projects.remove(input)
  • Access: workspace; project / admin
  • Effect annotation: May change state or run effects; destructive operation
InputRequirementDescription
idRequiredstring

project_assign

Move existing dashboards, folders, queries, charts, actions or panels into a project, or null for Unassigned. Moving a folder includes all its dashboards and their component views, retaining folder membership. Requires Write on each resource and the affected projects; folders also require dashboard folder management. Atomic; IDs, definitions, publications and dashboard bindings remain unchanged.

  • HTTP: POST /api/projects/assign
  • SDK: client.projects.assign(input)
  • Access: workspace; project / read
  • Effect annotation: May change state or run effects
InputRequirementDescription
projectIdRequiredSee schema
resourcesRequiredarray

On this page