plugin-outline (1.0.0-dev.ca456637)
Installation
registry=npm install plugin-outline@1.0.0-dev.ca456637"plugin-outline": "1.0.0-dev.ca456637"About this package
Outline
Outline knowledge base REST API (documents, collections, search, users, comments, shares, pins, stars, revisions, groups). API key auth
- Package:
plugin-outline - Author: Kai
- Version: 1.0.0
Credentials
| Key | Label | Type | Required | Default |
|---|---|---|---|---|
hostUrl |
Base URL (e.g. https://app.getoutline.com or self-hosted) | string | yes | – |
token |
API key | secret | yes | – |
verifyTls |
Verify TLS certificate | boolean | no | true |
Settings
| Key | Label | Type | Required | Default |
|---|---|---|---|---|
timeoutMs |
Timeout (ms) | number | no | 15000 |
allowDestructive |
Allow destructive tools (delete collection / document / comment / group, empty trash) | boolean | no | false |
Tools
| Tool | Description |
|---|---|
outline_ping |
Checks API access and reports the authenticated user and team (auth.info) |
outline_team_info |
Returns information about the workspace team (name, avatar, plan, sharing settings) |
outline_users_list |
Lists users of the workspace (optionally filtered and paginated) |
outline_users_info |
Returns a single user of the workspace |
outline_collections_list |
Lists all collections the user can access |
outline_collections_info |
Returns a single collection |
outline_collections_create |
Creates a new collection |
outline_collections_update |
Updates a collection (name, description, color, icon, permission, sharing, commenting) |
outline_collections_archive |
Archives a collection (documents become hidden, nothing is deleted) |
outline_collections_restore |
Restores a previously archived collection |
outline_collections_delete |
Deletes a collection and all of its documents (destructive, requires the allowDestructive setting and a confirm argument) |
outline_collections_documents |
Returns the full document tree of a collection (nested documents) |
outline_documents_list |
Lists documents (optionally filtered by collection, parent document, user or status) |
outline_documents_info |
Returns a single document including its markdown text and metadata |
outline_documents_search |
Full-text search across documents (returns matching documents with context snippets) |
outline_documents_create |
Creates a new document (title and markdown text; publish to make it visible) |
outline_documents_update |
Updates a document (title, markdown text, publish state; supports append/prepend/patch edit modes) |
outline_documents_move |
Moves a document to another collection or parent document (optionally with an index) |
outline_documents_duplicate |
Duplicates a document (optionally including child documents) |
outline_documents_export |
Exports a document as markdown text |
outline_documents_archive |
Archives a document (moves it to the archive, nothing is deleted) |
outline_documents_restore |
Restores an archived or deleted document (optionally to a collection or revision) |
outline_documents_unpublish |
Unpublishes a document (turns it into a draft, optionally detaches it from its collection) |
outline_documents_delete |
Moves a document to the trash, or permanently deletes it (destructive, requires the allowDestructive setting and a confirm argument) |
outline_documents_empty_trash |
Permanently deletes all documents in the trash (destructive, requires the allowDestructive setting and a confirm argument) |
outline_documents_archived |
Lists archived documents (optionally of one collection) |
outline_documents_deleted |
Lists documents in the trash |
outline_documents_drafts |
Lists draft documents |
outline_documents_viewed |
Lists recently viewed documents |
outline_comments_list |
Lists comments on a document or collection |
outline_comments_create |
Creates a comment on a document (plain text or markdown) |
outline_comments_delete |
Deletes a comment (destructive, requires the allowDestructive setting and a confirm argument) |
outline_views_list |
Returns analytics about who viewed a document (most recent views) |
outline_shares_list |
Lists public shares (optionally filtered and paginated) |
outline_shares_create |
Creates a public share link for a document or collection |
outline_shares_update |
Updates a public share link (publish state, indexing, url slug) |
outline_shares_revoke |
Revokes a public share link (the link stops working) |
outline_pins_list |
Lists pinned documents (optionally of one collection; no collection = Home pins) |
outline_pins_create |
Pins a document to a collection or to Home |
outline_pins_delete |
Removes a pin from a document |
outline_stars_list |
Lists starred documents and collections |
outline_stars_create |
Stars a document or collection |
outline_stars_update |
Moves a star to a new position in the sidebar |
outline_stars_delete |
Removes a star from a document or collection |
outline_revisions_list |
Lists the revision history of a document |
outline_revisions_info |
Returns a single revision including its markdown text |
outline_groups_list |
Lists user groups (optionally filtered and paginated) |
outline_groups_create |
Creates a new user group |
outline_groups_update |
Updates a user group |
outline_groups_delete |
Deletes a user group (destructive, requires the allowDestructive setting and a confirm argument) |
Keywords
mcp
mcp-plugin
outline
knowledge-base
wiki
documentation
Details
Assets (1)
Versions (3)
View all