update_collection
Modify collection details in Outline wiki, including name, description, and color, to organize and categorize documents effectively.
Instructions
Update collection information.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | ||
| name | No | ||
| description | No | ||
| color | No |
Implementation Reference
- src/lib/handlers/collections.ts:42-54 (handler)The main handler function for the 'update_collection' tool. Performs access control check, constructs payload from input args, calls the Outline API to update the collection, and returns formatted result.
async update_collection(args: UpdateCollectionInput) { checkAccess(config, 'update_collection'); const payload: Record<string, unknown> = { id: args.collectionId }; if (args.name) payload.name = args.name; if (args.description !== undefined) payload.description = args.description; if (args.color) payload.color = args.color; const { data } = await apiCall(() => apiClient.post<OutlineCollection>('/collections.update', payload) ); return colResult(data, MESSAGES.COLLECTION_UPDATED); }, - src/lib/schemas.ts:99-104 (schema)Zod schema definition for the input parameters of the update_collection tool, including optional name, description, and color updates for a given collectionId.
export const updateCollectionSchema = z.object({ collectionId, name: z.string().min(1).optional(), description: z.string().optional(), color: hexColor.optional(), }); - src/lib/tools.ts:151-155 (registration)Registers the 'update_collection' tool in the MCP tools list by creating its definition with name, description, and input schema derived from Zod.
createTool( 'update_collection', 'Update collection information.', 'update_collection' ), - src/lib/schemas.ts:191-191 (schema)TypeScript type inferred from the updateCollectionSchema for use in handler function signatures.
export type UpdateCollectionInput = z.infer<typeof updateCollectionSchema>; - src/lib/access-control.ts:12-29 (helper)Includes 'update_collection' in the set of write operation tools for access control checks.
const WRITE_TOOLS = new Set([ 'create_document', 'update_document', 'move_document', 'archive_document', 'unarchive_document', 'delete_document', 'restore_document', 'add_comment', 'create_collection', 'update_collection', 'delete_collection', 'batch_create_documents', 'batch_update_documents', 'batch_move_documents', 'batch_archive_documents', 'batch_delete_documents', ]);