Agent skill

Document Editor

by vellum-ai in vellum-ai/vellum-assistant

A skill your agent uses whenever the user wants to write or draft an article, blog post, essay, report, or any long-form content.

MITAuto-check passedWriting & Content

Install Document Editor

skills CLI
$ npx skills add vellum-ai/vellum-assistant --skill document-editor -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install vellum-ai/vellum-assistant document-editor --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/vellum-ai/vellum-assistant.git skills-src && mkdir -p .claude/skills && cp -r skills-src/assistant/src/config/bundled-skills/document-editor .claude/skills/document-editor && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
document-editor
GitHub stars
1.4k
Token cost
~2.7k tokens
SKILL.md length
1,336 words
Files
13
Skills in repo
108
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses whenever the user wants to write or draft an article, blog post, essay, report, or any long-form content.

  • Works in 3 steps: Create the document: Call… → Write content in Markdown: Use proper… → CRITICAL - Stream content in chunks:…
  • The user wants to write
  • SKILL.md covers Tools, Creating a new document, Editing an existing document and Retrieving existing documents, plus 4 more sections
  • Runs TypeScript scripts from its folder

What it does

Document Editor is an agent skill from vellum-ai/vellum-assistant. Use whenever the user wants to write or draft an article, blog post, essay, report, or any long-form content. Creates the content in a rich text editor instead of dumping it in chat, so it can be streamed, reviewed, edited, and exported.

Its SKILL.md is about 2.7k tokens, which your agent loads only when the skill is triggered. The skill folder holds 13 other files (for example `TOOLS.json`, `tools/comment-list.ts` and `tools/comment-reply.ts`). Compatibility notes: Designed for Vellum personal assistants

It sits in Writing & Content, covering Blog and article writing. The repository describes itself as: An AI Assistant that’s easy to setup, does your work 24/7, knows your preferences and gets better over time. The licence is MIT.

When your agent uses it

  • The user wants to write
  • Draft an article
  • Any long-form content

Example prompts

  • “/document-editor”

Requirements

  • Node.js
  • Compatibility (from SKILL.md): Designed for Vellum personal assistants

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. Create the document: Call document_create with a title (inferred from the request). Call the tool immediately, not after conversational…
  2. Write content in Markdown: Use proper structure (# for titles, ## for sections), bold, italic, code blocks, tables, lists, blockquotes as…
  3. CRITICAL - Stream content in chunks: Call document_update MULTIPLE times, not just once. Break content into logical chunks (paragraphs…

What it can do on your machine

Read from SKILL.md and the folder at commit c92ead1. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (TypeScript), which the agent can run.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Designed for Vellum personal assistants

    From compatibility in the SKILL.md frontmatter.

Context cost

Document Editor loads about 2.7k tokens when it runs. Until then it costs about 63 tokens; SKILL.md has 1,336 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~63
When it runs · the whole SKILL.md, loaded when a task matches
~2.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from vellum-ai/vellum-assistant at commit c92ead1, republished under its MIT licence (© vellum-ai). 1,336 words, ~2,659 tokens.

Download SKILL.mdSave it as .claude/skills/document-editor/SKILL.md (or your agent's skills folder). This skill also uses 12 other files; get the full folder from GitHub.
name
document-editor
description
Use whenever the user wants to write or draft an article, blog post, essay, report, or any long-form content. Creates the content in a rich text editor instead of dumping it in chat, so it can be streamed, reviewed, edited, and exported.
compatibility
Designed for Vellum personal assistants
metadata.emoji
✍️

Write and edit long-form documents using the built-in rich text editor. Documents open in workspace mode with chat docked to the side. When a request is about writing prose (an article, blog post, report, essay, story, or similar), create it here rather than writing it into the chat response.

Tools

  • document_create - Opens a new document editor with an optional title and initial Markdown content. Returns a surface_id for subsequent updates. This is the entry point for any new piece of writing.
  • document_update - Updates content in an open document editor by surface_id. Supports replace (overwrite) and append (add to end) modes.
  • document_read - Reads the current content of a document by surface_id when it belongs to the current conversation, or when the current actor is the guardian/local user. Use to verify content before editing.
  • document_find - Searches a document for text or regex patterns. Returns matching lines with line numbers, match positions, and matched text.
  • document_replace_text - Targeted find-and-replace within a document. Supports literal and regex patterns (with backreferences). Optionally limit the number of replacements.
  • document_list - Lists documents. Without query, lists the current conversation's documents. With query, searches by title; guardian/local users can search across conversations, while other actors are scoped to the current conversation.
  • document_open - Opens an existing document in the editor panel by surface_id. Use this when a document exists but isn't visible in the editor — for example after the user switches devices, refreshes the page, or when the editor panel was closed. Fetches the document from storage and sends it to the client.
  • document_delete - Deletes a document by surface_id. Use to clean up unwanted documents.

Creating a new document

This is the default path when the user asks you to write something.

  1. Create the document: Call document_create with a title (inferred from the request). Call the tool immediately, not after conversational preamble. Anything you pass as initial_content is saved right then, so the first document_update must start with the next chunk rather than repeating it.
  2. Write content in Markdown: Use proper structure (# for titles, ## for sections), bold, italic, code blocks, tables, lists, blockquotes as appropriate.
  3. CRITICAL - Stream content in chunks: Call document_update MULTIPLE times, not just once. Break content into logical chunks (paragraphs, sections, or every 200-300 words). Call document_update with mode: "append" for EACH chunk separately. Each append carries ONLY that chunk: content already in the document is committed, and resending it would print it twice. When you are streaming into the document you just created, surface_id is optional: omit it and pass only content, and the update targets that document. The user experiences real-time content appearing as you write.
Recovering from a failed update

If a document_update call fails with an Invalid input error, do NOT call document_create again — that produces a duplicate for the user. The most common cause is a missing content field: resend the call with the chunk's Markdown in content. You can omit surface_id to target the document you are currently writing; pass it explicitly only when editing a different existing document.

Editing an existing document

When the user requests changes to a document:

  1. Find the surface_id from the <active_documents> context block.
  2. Use document_update with the existing surface_id — do NOT call document_create again.
  3. Choose the right editing tool:
    • document_update with mode: "append" — adding new content to the end.
    • document_update with mode: "replace" — ONLY for full rewrites where the majority of the document is changing.
    • document_find + document_replace_text — for everything else. Fixing typos, renaming terms, swapping sections, reordering content, adjusting formatting, or any edit that touches only part of the document. This is the default choice for edits. It avoids rewriting the entire document and eliminates the risk of accidentally dropping content.
  4. Do NOT use document_update with mode: "replace" for targeted edits. Rewriting the entire document to change a few words or rearrange sections is wasteful and error-prone.

Retrieving existing documents

When the user asks to see, open, or pull up a document:

  1. Check the <active_documents> block in your context — it lists all documents in this conversation with their surface_id and title.
  2. If the document is NOT in <active_documents>, call document_list with a query matching the document title. For guardian/local users, this searches across previous conversations and sessions.
  3. Once you have the surface_id, call document_open to open the editor panel. This surfaces the editor on the client and returns document metadata (surface_id, title, word_count) — not the full content. If you need the actual document text, follow up with document_read.

Never search the filesystem, conversation history, or archives to find a document. Always use document_list with a query.

If the user says they can't see a document you know exists (e.g. after switching from macOS to web, or after a page refresh), call document_open with the surface_id to re-surface the editor panel on their current client.

Show full SKILL.md (538 more words)Show less

Find & Replace

Use document_find and document_replace_text for surgical edits that target specific text patterns without rewriting the entire document.

document_find

Search a document for literal text or regex patterns. Parameters:

  • surface_id (required) — the document to search
  • query (required) — the search string or regex pattern
  • regex (optional, default false) — treat query as a regular expression
  • case_sensitive (optional, default false) — match case exactly

Returns a list of matches with line numbers, line content, match positions, and matched text. Use this to preview what will be affected before making replacements.

document_replace_text

Targeted find-and-replace within a document. Parameters:

  • surface_id (required) — the document to modify
  • find (required) — the search string or regex pattern
  • replace (required) — the replacement string (supports $1, $2 backreferences when regex is true)
  • regex (optional, default false) — treat find as a regular expression
  • case_sensitive (optional, default false) — match case exactly
  • max_replacements (optional) — limit the number of replacements made

Returns the number of replacements made and whether the content changed.

Workflow
  1. Call document_find to preview matches and confirm the pattern is correct.
  2. Call document_replace_text to apply the changes.

Examples:

  • Fix a recurring typo: Find "recieve", replace with "receive".
  • Rename a term throughout: Find "widget" (case-insensitive), replace with "component".
  • Reformat dates with regex: Find (\d{2})/(\d{2})/(\d{4}) with regex: true, replace with $3-$1-$2 to convert MM/DD/YYYY to YYYY-MM-DD.
  • Swap or reorder sections: Use document_read to get the content, identify the sections to swap, then call document_replace_text to replace the first section with the second and vice versa. For complex rearrangements, use multiple document_replace_text calls with max_replacements: 1.

Comments

Users can leave inline comments on documents. Open comments are surfaced in a <document_comments> context block so you can see pending feedback.

  • comment_list — Lists open comments on a document by surface_id. Use this to check for feedback before or after editing, especially when the user asks you to address comments.
  • comment_resolve — Marks a comment as resolved by comment_id. Use this after you have addressed the feedback in the document content. Always edit the document first, then resolve the comment.
  • comment_reply — Posts a reply to an existing comment by comment_id. Use this to ask clarifying questions or explain why you made (or declined) a change before resolving.
Addressing comments workflow
  1. Read the <document_comments> block or call comment_list to see open comments.
  2. For each comment, edit the document to address the feedback.
  3. Call comment_resolve on comments you have addressed.
  4. If a comment is ambiguous, call comment_reply to ask for clarification instead of guessing.

Anti-Patterns

  • Don't use app_create for blog posts, articles, or written content. Use document_create — apps are for interactive content with state/data.
  • Don't write the article into the chat response. Long-form prose goes in the document editor via document_create, not in chat and not into a .md file in the workspace. Acknowledge what you're doing and stream to the editor.
  • Don't wait to generate everything before sending. Stream content in chunks via document_update with mode: "append" so users see progress in real time.

Usage Notes

  • The mode parameter on document_update defaults to append.
  • Documents are automatically saved and accessible via the Generated panel.
  • Users can manually edit documents at any time.
  • Write in clear, engaging prose. Use active voice, vary sentence structure, and break content into logical sections with descriptive headings.

© vellum-ai, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 12 other files in assistant/src/config/bundled-skills/document-editor of vellum-ai/vellum-assistant.

  • SKILL.md
  • TOOLS.json
  • tools/comment-list.ts
  • tools/comment-reply.ts
  • tools/comment-resolve.ts
  • tools/document-create.ts
  • tools/document-delete.ts
  • tools/document-find.ts
  • tools/document-list.ts
  • tools/document-open.ts
  • tools/document-read.ts
  • tools/document-replace-text.ts
  • tools/document-update.ts

Open the folder on GitHubat commit c92ead1

Compare with similar skills

Document Editor next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Document Editor compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Document Editor this skillvellum-ai/vellum-assistant1.4k—~2.7kAutomated safety check: PassMIT
Khazix WeChat Article WriterKKKKhazix/khazix-skills21k2 repos~2.9kAutomated safety check: PassMIT
Figurevectorize-io/hindsight47k—~1.9kAutomated safety check: PassMIT
SepiaNanako0129/sepia3k—~3.6kAutomated safety check: PassMIT
Blog Post Draftingluongnv89/claude-howto42k—~2.1kAutomated safety check: PassMIT
Notion To Blogwasp-lang/wasp19k—~922Automated safety check: PassMIT

Similar skills

  • Khazix WeChat Article Writer

    KKKKhazix/khazix-skills

    Writes long-form WeChat official account articles in the personal style of the Khazix account, from briefs, links, PDFs or rough notes, with a topic quality check.

    21k GitHub starsUsed in 2 repos~2.9k tokens
    Writing & ContentAuto-check passed
  • Figure

    vectorize-io/hindsight

    Draw an animated figure (boxes, arrows, moving data) as one self-contained SVG for a GitHub README, PR, issue or blog post.

    47k GitHub stars~1.9k tokensUpdated today
    Writing & ContentAuto-check passed
  • Sepia

    Nanako0129/sepia

    Make AI-generated writing read as human-written, in fiction and in professional prose.

    3k GitHub stars~3.6k tokensUpdated 2 days ago
    Writing & ContentAuto-check passed
  • Blog Post Drafting

    luongnv89/claude-howto

    Guides drafting a blog post from an idea and optional source material: research, brainstorming, outlining and version-tracked drafts, with user approval at each step.

    42k GitHub stars~2.1k tokensUpdated 8 days ago
    Writing & ContentAuto-check passed
  • Notion To Blog

    wasp-lang/wasp

    Transfer a blog post from Notion to the Wasp blog. An agent skill from wasp-lang/wasp.

    19k GitHub stars~922 tokensUpdated yesterday
    Writing & ContentAuto-check passed
  • Blog Post

    nteract/semiotic

    Author a new entry for the Semiotic blog. An agent skill from nteract/semiotic.

    2.7k GitHub stars~3.4k tokensUpdated yesterday
    Writing & ContentAuto-check passed

More from vellum-ai/vellum-assistant

All 108 skills in this repo
  • Vellum GitHub App Setup

    vellum-ai/vellum-assistant

    Create and configure a GitHub App so the assistant can push commits, open PRs, and comment under its own bot identity.

    1.4k GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Discord App Setup

    vellum-ai/vellum-assistant

    Connect a Discord bot to the assistant via the Discord Gateway with guided application creation and intent configuration

    1.4k GitHub stars~4.2k tokensUpdated today
    Auto-check passed
  • Sentry App Setup

    vellum-ai/vellum-assistant

    Create and configure a Sentry internal integration so the assistant can manage issues, alerts, and releases under its own identity

    1.4k GitHub stars~1.3k tokensUpdated today
    Auto-check passed
  • Memory Corpus Ingest

    vellum-ai/vellum-assistant

    Ingest a large dataset into memory as a skimmed map. An agent skill from vellum-ai/vellum-assistant.

    1.4k GitHub stars~3k tokensUpdated today
    Auto-check: notes
  • Plugin Builder

    vellum-ai/vellum-assistant

    A skill your agent uses when the user wants to build, scaffold, ship, or edit a Vellum plugin that bundles multiple surfaces (hooks, tools, skills, and more) into one installable package.

    1.4k GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Slack App Setup

    vellum-ai/vellum-assistant

    Connect a Slack app to the Vellum Assistant via Socket Mode.

    1.4k GitHub stars~2.5k tokensUpdated today
    Auto-check: warnings

Questions about Document Editor

What does Document Editor do?

A skill your agent uses whenever the user wants to write or draft an article, blog post, essay, report, or any long-form content. Document Editor is an agent skill from vellum-ai/vellum-assistant. Use whenever the user wants to write or draft an article, blog post, essay, report, or any long-form content.

When should I use Document Editor?

Document Editor fits situations like: the user wants to write; draft an article; any long-form content.

How do I install Document Editor in Claude Code?

Run `npx skills add vellum-ai/vellum-assistant --skill document-editor -a claude-code`. Or copy the skill folder (assistant/src/config/bundled-skills/document-editor in vellum-ai/vellum-assistant) into .claude/skills/document-editor in your project. Claude Code loads it when a task matches its description.

How do I install Document Editor in Codex?

Run `npx skills add vellum-ai/vellum-assistant --skill document-editor -a codex`. Or copy the skill folder (assistant/src/config/bundled-skills/document-editor in vellum-ai/vellum-assistant) into .agents/skills/document-editor in your project. Codex loads it when a task matches its description.

Can I use Document Editor in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add vellum-ai/vellum-assistant --skill document-editor -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document-editor, .gemini/skills/document-editor, .github/skills/document-editor and .opencode/skills/document-editor in your project.

What does Document Editor need to run?

Going by SKILL.md and its folder, Document Editor needs TypeScript for the scripts in its folder. Our summary lists: Node.js. Compatibility (from SKILL.md): Designed for Vellum personal assistants.

Does Document Editor access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Document Editor safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Document Editor use?

Document Editor is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Document Editor use?

About 2.7k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Document Editor?

Skills that share tags, products or a category with Document Editor: Khazix WeChat Article Writer (KKKKhazix/khazix-skills, 21k stars), Figure (vectorize-io/hindsight, 47k stars), Sepia (Nanako0129/sepia, 3k stars) and Blog Post Drafting (luongnv89/claude-howto, 42k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Document Editor?

vellum-ai (a GitHub organization) maintains it in vellum-ai/vellum-assistant, which has 1,397 GitHub stars. The repository holds 108 skills in this directory. The repository was last updated on October 7, 2026.

Source: vellum-ai/vellum-assistant on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.