agentleFS
huangy7huangy7/outline-skill/SKILL.md

outline-wiki

Skill5 starsChanged 38 days agoMITView on GitHub

Use when the user wants to search, read, create, update, organize, or format notes and documentation in an Outline knowledge base.

  • Reads credentials

2 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 2

    1. justmiles/skills★ 1same name
    2. alokn/claude-skills★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. About 0 are common, 5 are distinctive, and 8 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before performing operations, verify that Outline credentials are configured:

    line 14
  2. Distinctive:

    If credentials are not found:

    line 19
  3. Distinctive:

    Ask the user for their Outline Instance URL and API Token (generated in Outline under Settings -> Account -> API Tokens).

    line 20
  4. Distinctive:

    If the current agent environment has Outline MCP server configured, prefer using the registered tools:

    line 35
  5. Very specific:

    If MCP tools are not active in the session, use the bundled standalone script scripts/outline-client.mjs:

    line 42
  6. Distinctive:

    When preparing document content, strictly follow these rules:

    line 64
  7. Very specific:

    Start directly with an introductory overview paragraph or a second-level heading (## 概述).

    line 69
  8. Very specific:

    Use ## for primary sections, ### for subsections.

    line 76
  9. Very specific:

    Ensure all code blocks specify their language tag (e.g.

    line 77
  10. Very specific:

    Use checklist tasks - [ ] and - [x] for operational checklists and runbooks.

    line 78
  11. Very specific:

    Search for Duplicates: Search existing documents using documents:search to avoid duplicate notes.

    line 87
  12. Very specific:

    Publish: Call documents:create (or MCP create_document).

    line 90
  13. Very specific:

    Call documents:update to save modifications.

    line 95

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Outline Wiki Skill

This skill guides the AI Agent in searching, reading, drafting, formatting, and organizing documentation and notes in an Outline knowledge base (getoutline.com or self-hosted).


1. Prerequisites and Configuration Check

Before performing operations, verify that Outline credentials are configured:

  1. Environment Variables: OUTLINE_URL (or OUTLINE_INSTANCE_URL) and OUTLINE_API_KEY (or OUTLINE_TOKEN).
  2. Config File: ~/.config/outline-skill/config.json containing { "url": "...", "token": "..." }.

If credentials are not found:

  • Ask the user for their Outline Instance URL and API Token (generated in Outline under Settings -> Account -> API Tokens).
  • Or suggest running: npx outline-skill setup in their terminal.

To verify connectivity:

node scripts/outline-client.mjs auth:check

2. Core Operation Modes

The Agent can interact with Outline via two complementary methods:

Mode A: Via Native MCP Tools (When Available)

If the current agent environment has Outline MCP server configured, prefer using the registered tools:

  • list_documents / list_collection_documents: Search or browse documents.
  • create_document: Create a new document in a collection.
  • update_document: Edit or append text to an existing document.
  • list_collections: List collections to identify the appropriate target collection.

Mode B: Via Bundled CLI Client (Universal Fallback)

If MCP tools are not active in the session, use the bundled standalone script scripts/outline-client.mjs:

# List collections
node scripts/outline-client.mjs collections:list

# Search documents
node scripts/outline-client.mjs documents:search --query "关键字"

# View document details
node scripts/outline-client.mjs documents:info --id "<documentId>"

# Create document
node scripts/outline-client.mjs documents:create --title "<标题>" --collection "<collectionId>" --file "<path-to-markdown>"

# Update or append document
node scripts/outline-client.mjs documents:update --id "<documentId>" --append "<追加文本>"

3. Formatting Conventions for Outline

When preparing document content, strictly follow these rules:

  1. Do NOT Start with Top-Level Heading (# Title):
    • Outline stores the title as a separate metadata field and renders it automatically.
    • Starting markdown with # Title produces an awkward duplicate title.
    • Start directly with an introductory overview paragraph or a second-level heading (## 概述).
  2. Use Outline Callouts for Highlights:
    • :::info: General tips, context, or neutral notes.
    • :::tip: Pro-tips and best practices.
    • :::warning: Important alerts and caveats.
    • :::danger: High-risk operations or potential data loss warnings.
  3. Structured Hierarchy:
    • Use ## for primary sections, ### for subsections.
    • Ensure all code blocks specify their language tag (e.g. bash`, yaml, ````json).
    • Use checklist tasks - [ ] and - [x] for operational checklists and runbooks.
    • Detailed formatting guidelines are available in references/formatting-guide.md.

4. Standard Note-Taking Workflows

Workflow: Turning Conversations into Knowledge Base Articles

  1. Analyze and Structure: Extract key concepts, problem statements, solutions, commands, and lessons learned.
  2. Search for Duplicates: Search existing documents using documents:search to avoid duplicate notes.
  3. Select or Create Collection: Browse available collections (collections:list). Choose the best fit (e.g., "运维笔记", "开发文档").
  4. Draft and Review: Draft the document adhering to the formatting conventions above.
  5. Publish: Call documents:create (or MCP create_document). Return the created document URL to the user.

Workflow: Updating Existing Knowledge Base Pages

  1. Retrieve existing document content with documents:info.
  2. Seamlessly integrate new sections, updates, or append changelog entries.
  3. Call documents:update to save modifications.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.