mcpField
O
outline

outline

github.com/sanjay3290Productivity447384 installsUpdated 7w ago
Repository

About outline

A skill for searching, reading, creating, and managing documents in Outline wiki instances. It is intended for AI clients that support the Agent Skills Standard and can also work with self-hosted instances through a configurable API URL.

Key features

  1. 01Search documents
  2. 02Read and export documents as Markdown
  3. 03List collections and documents
  4. 04Create and update documents
  5. 05Return machine-readable JSON output

Use cases

  1. 01Find wiki guidance by keyword
  2. 02Read or export a document
  3. 03Create or revise wiki content
  4. 04Inspect collections and their documents

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/sanjay3290/ai-skills --skill outline

After installing, type/outlinein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

.env.example
.gitignore
README.md
requirements.txt
scripts/
outline.py

Details

From the project README

Outline Wiki Skill

Search, read, create, and manage documents in any Outline wiki instance. Works with all AI clients supporting the Agent Skills Standard.

Requirements

  • Python 3.8+
  • Dependencies: pip install -r requirements.txt

Setup

  1. Get your API key from your Outline wiki:

    • Go to Settings > API Tokens
    • Create a new token with appropriate permissions

  2. Configure the environment:

    cp .env.example .env
# Edit .env with your API key

  3. Set the environment variables:

    export OUTLINE_API_KEY=your-api-key-here
# Optional: for self-hosted instances
export OUTLINE_API_URL=https://your-wiki.example.com/api

Usage

Search documents
python3 scripts/outline.py search "deployment guide"
python3 scripts/outline.py search "API documentation" --limit 10
python3 scripts/outline.py search "onboarding" --collection-id <id>
Read a document
python3 scripts/outline.py read <document-id>
python3 scripts/outline.py read <document-id> --json
List collections
python3 scripts/outline.py list-collections
python3 scripts/outline.py list-collections --limit 50
List documents in a collection
python3 scripts/outline.py list-documents --collection-id <id>
Get collection details
python3 scripts/outline.py get-collection <collection-id>
Create a document
python3 scripts/outline.py create --title "New Guide" --collection-id <id>
python3 scripts/outline.py create --title "Guide" --collection-id <id> --text "# Content here"
python3 scripts/outline.py create --title "Draft" --collection-id <id> --draft
Update a document
python3 scripts/outline.py update <document-id> --title "Updated Title"
python3 scripts/outline.py update <document-id> --text "New content"
python3 scripts/outline.py update <document-id> --publish
Export document as markdown
python3 scripts/outline.py export <document-id>
python3 scripts/outline.py export <document-id> --output doc.md
Test authentication
python3 scripts/outline.py auth-info

JSON Output

Add --json flag to any command for machine-readable output:

python3 scripts/outline.py search "query" --json
python3 scripts/outline.py read <id> --json

Operations Reference

CommandDescriptionRequired Args
searchFull-text searchquery
readGet document contentdocument_id
list-collectionsList all collections-
list-documentsList docs (optionally in collection)-
get-collectionGet collection detailscollection_id
createCreate new document--title, --collection-id
updateUpdate existing documentdocument_id
exportExport as markdowndocument_id
auth-infoTest API connection-

Environment Variables

VariableRequiredDefaultDescription
OUTLINE_API_KEYYes-Your Outline API token
OUTLINE_API_URLNohttps://app.getoutline.com/apiAPI URL
OUTLINE_TIMEOUTNo30Request timeout (seconds)
OUTLINE_VERIFY_SSLNotrueSet to false to skip SSL verification (for self-hosted instances with self-signed certs)

Troubleshooting

ErrorSolution
API key not configuredSet OUTLINE_API_KEY environment variable
Authentication failedVerify API key is valid and not expired
Connection timeoutCheck OUTLINE_API_URL and network connectivity
SSL certificate errorSet OUTLINE_VERIFY_SSL=false for self-signed certs
Document not foundVerify document ID is correct
Permission deniedCheck API token has required permissions

Exit Codes

  • 0: Success
  • 1: Error (auth failed, not found, invalid request)

Workflow

  1. Run auth-info to verify connection
  2. Run list-collections to see available collections
  3. Run search or list-documents to find content
  4. Run read to get full document content
  5. Use create/update to modify wiki content

Comments

Markdown supported