> ## Documentation Index
> Fetch the complete documentation index at: https://aspect.inc/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Tool reference

> Find Aspect MCP tools for media search, files, transcripts, canvases, generation, review, and permissions.

These are the tool names exposed by Aspect's remote MCP server. Your client may display a server prefix in front of them. Inspect the connected tool schema for exact input types, required fields, and supported options before constructing a call.

Batch IDs when a tool accepts a list. For listing and search tools that expose pagination, request additional pages rather than assuming the first response is the complete library.

### Workspaces

| Tool | Description |
| - | - |
| `workspaces_list` | List workspaces available to you. |
| `workspaces_get` | Get a workspace you can view. |
| `workspaces_update` | Update a workspace you can edit. |
| `workspaces_users_list` | List people in a workspace, including roles and project permission counts. |
| `workspaces_users_add` | Add people to a workspace with workspace roles. |
| `workspaces_users_update` | Update workspace roles for people. |
| `workspaces_users_remove` | Remove people from a workspace, including their project permissions. |
| `workspaces_users_all_project_access_list` | List a person's project access: effective roles, project defaults, and explicit overrides. |

### Projects

| Tool | Description |
| - | - |
| `projects_list` | List projects in a workspace you can view. |
| `projects_get` | Get projects by ID. |
| `projects_create` | Create projects in a workspace you can edit. |
| `projects_update` | Update projects you can edit. |
| `projects_users_list` | List people with access to a project, including inherited versus explicit roles. |
| `projects_users_add` | Add people to a project with project roles. |
| `projects_users_update` | Update project roles for people. |
| `projects_users_remove` | Remove explicit project permissions. Workspace members revert to the project default role; limited members lose project access. |

For files and folders at the top level of a project, call `projects_get` and use its `root_directory_id` as the parent directory ID.

### Directories

| Tool | Description |
| - | - |
| `directories_list` | List child directories under a directory you can view. |
| `directories_get` | Get directories by ID. |
| `directories_create` | Create child directories under directories you can edit. |
| `directories_update` | Rename or recolor directories. |
| `directories_delete` | Move directories to the project trash. |
| `fs_items_move` | Move assets, directories, and symlinks to a destination directory. |
| `fs_items_copy` | Copy assets, directories, and symlinks into a destination directory via an asynchronous copy job. |

Copies can go to another project in the same workspace. When copying across projects, values of project-specific metadata fields and matches to project-specific entities or objects do not carry over. Destination name conflicts are resolved by adding a suffix to the copy's name.

### Assets

| Tool | Description |
| - | - |
| `assets_list` | List assets under a parent resource you can view. |
| `assets_get` | Get assets by ID. |
| `assets_update` | Rename assets (the new name must include the file extension). |
| `assets_delete` | Move assets to the project trash. |
| `assets_document_get` | Get extracted text from a document asset (PDF, slide deck, spreadsheet, and more), optionally selecting specific page numbers. |
| `assets_timecode_get` | Convert positions in seconds to a video's SMPTE timecodes, matching the Aspect player and using the recorded source start timecode when available. |

Timecode conversion accepts multiple positions for one asset in a single call. If the asset has no frame rate usable for timecode, the tool returns null timecodes with a reason.

### Search

| Tool | Description |
| - | - |
| `assets_search` | Search a project or a single asset using visual, transcript, document, and filename signals plus metadata filters; results include matched clip timing. |
| `assets_search_capabilities` | List available search channels, filterable metadata attributes, valid filter clauses, and selectable option, Face, and user IDs. |

Use `assets_search_capabilities` before building metadata or Face filters. Use `entities_list` to look up the recognized people you want to search for.

### Transcription

| Tool | Description |
| - | - |
| `assets_transcription_get` | Get an asset's transcript, optionally scoped to a start and end time. |

### Asset content

| Tool | Description |
| - | - |
| `assets_content_get` | Read indexed scene captions and speech together in time order for video, image, or audio assets. Filter to visual or transcript entries, or a time range. |

Content and transcript tools return indexed information. `assets_content_get` returns no entries when the asset has not been processed or has no content for the requested track.

### Collections

| Tool | Description |
| - | - |
| `collections_list` | List collections in a project you can view. |
| `collections_get` | Get collections by ID. |
| `collections_create` | Create collections in projects you can edit. |
| `collections_update` | Update collections you can edit. |
| `collections_delete` | Delete collections where you have full access. |
| `collections_items_add` | Add asset or directory items to a collection. |
| `collections_items_remove` | Remove asset or directory items from a collection. |

### Metadata

| Tool | Description |
| - | - |
| `metadata_attributes_list` | List metadata attributes available in a project, including custom fields. |
| `metadata_attributes_get` | Get metadata attribute details. |
| `metadata_attributes_create` | Create custom metadata attributes. |
| `metadata_attributes_update` | Update custom metadata attributes. |
| `metadata_attributes_delete` | Delete custom metadata attributes. |
| `asset_metadata_get` | Get custom metadata values for an asset. |
| `asset_metadata_set` | Set custom metadata values on an asset. |

### Comments

| Tool | Description |
| - | - |
| `comments_get` | Get comment threads on resources you can comment on, including replies. |
| `comments_search` | Search project comments, with filters for resources, people, resolution state, timestamps, and more. |
| `comments_create` | Create plain-text comments or replies on assets, including private/internal comments, video time ranges, and document pages. |

Comment creation does not support drawing annotations, text highlights, mentions, or attachments.

### Share links

| Tool | Description |
| - | - |
| `share_links_create` | Create share links for assets, directories, or collections you fully control. |
| `share_links_list` | List share links for one resource or a whole project. |
| `share_links_update` | Update share links you can manage. |
| `share_links_delete` | Delete share links you can manage. |

Created and listed links include a `client_url`. Asset share links also include an `embed_url` for embedding the asset in an external site.

### Other

| Tool | Description |
| - | - |
| `entities_list` | List labeled entities (such as recognized people) available for a workspace or project. |
| `notifications_list` | List your in-app notifications, including comments, mentions, and replies, filtered by read state. |
| `recents_list` | List recently accessed resources in a workspace, most recent first, with pagination. |

### Canvases

| Tool | Description |
| - | - |
| `canvases_list` | List canvases in a project. |
| `canvases_get` | Get canvases by ID. |
| `canvases_create` | Create named canvases in projects you can edit. |
| `canvases_update` | Rename canvases. |
| `canvases_delete` | Delete canvases and their nodes and edges where you have full access. |
| `canvas_content_get` | Read nodes, connections, positions, and generation state. |
| `canvas_nodes_create` | Add nodes, optionally wiring them together in the same call. |
| `canvas_nodes_update` | Change node properties or positions. |
| `canvas_nodes_delete` | Delete nodes and their connected edges. |
| `canvas_edges_create` | Connect compatible node outputs and model inputs. |
| `canvas_edges_delete` | Remove connections. |

Read `canvas_content_get` before changing a canvas. Use the returned IDs and preserve existing content. Node positions affect the order of inputs consumed by connected generation nodes. Model input rules still apply to connections created through MCP.

### Generation

| Tool | Description |
| - | - |
| `generations_models_list` | Discover available models, parameters, and supported inputs. |
| `generations_run` | Start a generation using a model and prompt, with optional inputs and canvas placement. |
| `generations_run_get` | Check a generation run and retrieve its result or failure. |

Discover the model's current input requirements before starting a run. Starting a generation is a write operation and can consume generation credits. A returned run ID means the job was accepted; check its result before using the output. Use `generations_run_get` for a one-off status check when needed; do not repeatedly poll to wait for completion.

## File and editor boundaries

MCP organizes cloud resources. Use the [Aspect CLI](/docs/cli/index) for uploads, downloads, mounts, and local pins. Use the editor's own integration to operate a timeline.

`fs_items_copy` returns `job_id` and `items_total`; it queues a copy instead of waiting for every asset. The remote MCP schema currently exposes `include_comments` and `include_metadata`, but does not expose the **Copy videos as proxies** option. Use the [agentic editing workflow](/docs/workflows/agentic-video-editing) for the supported proxy-copy route.

The server does not expose workspace creation or deletion, project deletion, emptying trash, direct download URLs, storage tokens, or public share sessions. Asset and directory deletion moves those items to project trash. Canvas and collection deletion have their own access requirements and should not be treated as file-trash operations.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.