Skip to main content

​
update_workspace

Updates the name or description of an existing workspace.

​
Tool Schema

{
  "name": "update_workspace",
  "description": "Update a workspace",
  "inputSchema": {
    "type": "object",
    "properties": {
      "workspace_id": {
        "type": "string",
        "description": "The ID of the workspace to update"
      },
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "description": "The new name of the workspace"
      },
      "description": {
        "type": "string",
        "description": "The new description of the workspace"
      }
    },
    "required": ["workspace_id"]
  }
}

​
Parameters

ParameterTypeRequiredDescription
workspace_idstringYesThe ID of the workspace to update
namestringNoThe new name of the workspace (1-255 characters)
descriptionstringNoThe new description of the workspace

​
Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated Design System",
  "description": "Updated description for the design system",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-20T16:45:00Z"
}

​
Example Usage in Claude

​
Update Workspace Name

You: Rename my workspace with ID 550e8400-e29b-41d4-a716-446655440000 to "Brand Design System"

Claude: I'll update the workspace name to "Brand Design System".

Workspace updated successfully:
- **Name**: Brand Design System (updated)
- **Description**: Updated description for the design system

​
Update Workspace Description

You: Update the description of workspace 550e8400-e29b-41d4-a716-446655440000 to "Main brand design system for all products"

Claude: I'll update the workspace description.

Workspace updated successfully:
- **Name**: Brand Design System
- **Description**: Main brand design system for all products (updated)

​
Update Both Name and Description

You: Change workspace 550e8400-e29b-41d4-a716-446655440000 to "Global Brand System" with description "Unified design tokens for all brand touchpoints"

Claude: I'll update both the name and description of the workspace.

Workspace updated successfully:
- **Name**: Global Brand System (updated)
- **Description**: Unified design tokens for all brand touchpoints (updated)

​
Common Use Cases

​
1. Project Evolution

You: The "Mobile App" workspace should now be called "Cross-Platform App"

​
2. Better Organization

You: Update the workspace description to better reflect its purpose

​
3. Client Name Changes

You: Rename the Acme Corp workspace to Acme Inc. after their rebrand

​
Notes

  • At least one of name or description must be provided
  • Workspace names must be unique within your account
  • The updated_at timestamp will be automatically updated
  • All existing tokensets and tokens within the workspace remain unchanged

​
See Also