User Guides
Tool Reference
Complete, use-case-oriented reference for tools and resource URIs.
This page groups tools by operational intent so you can choose the right API surface quickly.
| Use case | Main tools |
|---|
| Server runtime inspection | server_info |
| Collection discovery and management | list_collections, create_collection, update_collection, delete_collection |
| Document search and reading | search_documents, read_document, export_document |
| Document writing and movement | create_document, update_document, move_document, safe_update_document |
| Document lifecycle | delete_document, archive_document, unarchive_document, restore_document, list_archived_documents, list_trash |
| Use case | Main tools |
|---|
| Create many documents | batch_create_documents |
| Update many documents | batch_update_documents |
| Move many documents | batch_move_documents |
| Archive many documents | batch_archive_documents |
| Delete many documents | batch_delete_documents |
| Use case | Main tools |
|---|
| Inspect collection tree | get_collection_structure |
| Resolve doc ID from title | get_document_id_from_title |
| Find inbound links | get_document_backlinks |
| Ask Outline AI over docs | ask_ai_about_documents |
| Use case | Main tools |
|---|
| Template workflows | list_templates, create_template_from_document, create_document_from_template |
| Comment workflows | list_comments, get_comment, create_comment, update_comment, delete_comment |
| Membership management | list_document_users, list_document_memberships, list_document_group_memberships, add_document_user, remove_document_user, add_document_group, remove_document_group, list_collection_memberships, list_collection_group_memberships, add_collection_user, remove_collection_user, add_collection_group, remove_collection_group |
| Use case | Main tools |
|---|
| Audit and revisions | list_events, list_revisions, get_revision |
| Export and artifact handling | export_collection, export_all_collections, list_file_operations, get_file_operation, download_file_operation |
| Concurrent ownership control | acquire_document_lease, renew_document_lease, release_document_lease, get_active_document_lease |
These resources are useful when the model should read context directly by URI.
outline://collection/{collection_id}outline://collection/{collection_id}/treeoutline://collection/{collection_id}/documentsoutline://document/{document_id}outline://document/{document_id}/backlinks
- Prefer read and structure tools first when planning a change.
- Use lifecycle and batch tools only when ownership boundaries are clear.
- Use lease plus
safe_update_document together for multi-agent writes.