Agent skill

Notion

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

Read and write Notion pages and databases using the Notion API

MITAuto-check passedBackend & APIs

Install Notion

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

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

GitHub CLI
$ gh skill install vellum-ai/vellum-assistant notion --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/skills/notion .claude/skills/notion && 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
notion
GitHub stars
1.4k
Token cost
~2.7k tokens
SKILL.md length
896 words
Files
2 (incl. assets)
Skills in repo
108
Repo updated
First seen
Licence
MIT

At a glance

Read and write Notion pages and databases using the Notion API

  • Backend & APIs work in your project
  • SKILL.md covers Authentication, Reading Pages, Searching and Reading Databases, plus 6 more sections
  • Calls curl; reaches api.notion.com and notion.so

What it does

Notion is an agent skill from vellum-ai/vellum-assistant. Read and write Notion pages and databases using the Notion API

Its SKILL.md is about 2.7k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including assets. Compatibility notes: Designed for Vellum personal assistants

It sits in Backend & APIs. It works with Notion. 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

  • Backend & APIs work in your project

Example prompts

  • “/notion”

Requirements

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

What it can do on your machine

Read from SKILL.md and the folder at commit 33cc983. 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

    Shell commands in SKILL.md call:

    • curl

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

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • api.notion.com
    • notion.so

    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

Notion loads about 2.7k tokens when it runs. Until then it costs about 17 tokens; SKILL.md has 896 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~17
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 33cc983, republished under its MIT licence (© vellum-ai). 896 words, ~2,723 tokens.

Download SKILL.mdSave it as .claude/skills/notion/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
notion
description
Read and write Notion pages and databases using the Notion API
compatibility
Designed for Vellum personal assistants
metadata.icon
assets/icon.svg
metadata.emoji
📝

You have access to the Notion API via the managed OAuth connection or an internal integration secret stored in the credential vault. Both paths inject the Authorization header automatically. Never reveal credential values or echo token values into the shell.

Authentication

Step 1 - Determine connection type:

bash
assistant credentials list

Look at the results to decide which path to use:

  • Managed OAuth (preferred): No service: "notion" entry is needed in the vault. The OAuth connection is managed by the platform. Use Path A below.
  • Internal integration secret: An entry with service: "notion" and field: "internal_secret" is present. Use Path A below (recommended) or Path B if the credential has the required metadata (see Path B for details).
  • Neither configured: Tell the user: "Notion is not connected yet. Load the vellum-oauth-integrations skill to set it up first."

Step 2 - Make authenticated API calls:

Choose the path that matches what you found in Step 1.


Path A. Managed OAuth (preferred)

Use assistant oauth request --provider notion. The Authorization header is injected automatically; do not supply it manually.

assistant oauth request --provider notion \
  -X POST \
  -H "Notion-Version: 2022-06-28" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.notion.com/v1/search

General shape: assistant oauth request --provider notion -X <METHOD> -H "Notion-Version: 2022-06-28" [-H "Content-Type: application/json"] [-d '<json-body>'] <url>

  • URL can be absolute (https://api.notion.com/v1/pages/...) or relative (/v1/pages/...).
  • -d accepts inline JSON, @filename, or @- for stdin.
  • Token refresh is handled automatically.

Path B. Proxied bash with credential auto-injection

Note: The standard Notion setup flow (vellum-oauth-integrations) does not currently produce credentials with the metadata required by this path. Most users should use Path A instead. Path B is documented for credentials that have been manually configured with the required metadata.

For internal integration secrets registered with allowedTools: ["bash"] and an injection_templates entry for api.notion.com. The proxy adds Authorization: Bearer <token> automatically. Do not include an Authorization header in the curl command.

bash:
  network_mode: proxied
  credential_ids: ["<credential_id_from_step_1>"]
  command: |
    curl -s -X POST https://api.notion.com/v1/search \
      -H "Notion-Version: 2022-06-28" \
      -H "Content-Type: application/json" \
      -d '{}'

Where <credential_id_from_step_1> is the id field from the matching entry in assistant credentials list output.

The credential MUST have:

  • allowedTools including "bash" (otherwise the proxy blocks the call).
  • injection_templates with host pattern api.notion.com and header injection type for Authorization.

If these are missing, you will get a credential tool policy denied error. Switch to Path A instead.


All Notion API calls go to https://api.notion.com/v1/. Always include the Notion-Version: 2022-06-28 header.

Reading Pages

Get a page by ID
GET https://api.notion.com/v1/pages/{page_id}

Returns page properties. Use the page ID from a Notion URL - the last segment of the URL, e.g. for https://notion.so/My-Page-abc123def456 the ID is abc123def456 (formatted as UUID: abc123de-f456-...).

Get page content (blocks)
GET https://api.notion.com/v1/blocks/{block_id}/children?page_size=100

Pages are blocks too - use the page ID as the block_id. Iterates through the page's child blocks. Use start_cursor for pagination when has_more is true.

Block types and how to render them:

  • paragraph: Read paragraph.rich_text[].plain_text
  • heading_1, heading_2, heading_3: Read heading_N.rich_text[].plain_text
  • bulleted_list_item, numbered_list_item: Read *.rich_text[].plain_text
  • to_do: Read to_do.rich_text[].plain_text and to_do.checked
  • toggle: Read toggle.rich_text[].plain_text; children are nested blocks
  • code: Read code.rich_text[].plain_text and code.language
  • quote: Read quote.rich_text[].plain_text
  • callout: Read callout.rich_text[].plain_text
  • divider: Render as ---
  • image: Read image.external.url or image.file.url
  • child_page: Read child_page.title; use its id to recursively fetch if needed

Searching

Search pages and databases
POST https://api.notion.com/v1/search
{
  "query": "your search term",
  "filter": { "value": "page", "property": "object" },
  "sort": { "direction": "descending", "timestamp": "last_edited_time" },
  "page_size": 10
}

Omit filter to search both pages and databases. Use filter.value: "database" to search only databases.

Returns results[] with id, url, properties.title (for pages), and title[] (for databases).

Reading Databases

Get database metadata
GET https://api.notion.com/v1/databases/{database_id}

Returns the database schema (all property definitions).

Show full SKILL.md (368 more words)Show less
Query a database
POST https://api.notion.com/v1/databases/{database_id}/query
{
  "filter": {
    "property": "Status",
    "select": { "equals": "In Progress" }
  },
  "sorts": [
    { "property": "Created", "direction": "descending" }
  ],
  "page_size": 20
}

Omit filter to retrieve all rows. Returns results[] where each item is a page (database row).

Extracting property values from database rows:

  • title: properties.Name.title[].plain_text
  • rich_text: properties.Notes.rich_text[].plain_text
  • number: properties.Price.number
  • select: properties.Status.select.name
  • multi_select: properties.Tags.multi_select[].name
  • date: properties.Due.date.start (ISO 8601)
  • checkbox: properties.Done.checkbox
  • url: properties.Link.url
  • email: properties.Email.email
  • people: properties.Owner.people[].name
  • relation: properties.Projects.relation[].id (array of page IDs)

Creating Pages

Create a new page
POST https://api.notion.com/v1/pages
{
  "parent": { "page_id": "<parent_page_id>" },
  "properties": {
    "title": {
      "title": [{ "text": { "content": "My New Page" } }]
    }
  },
  "children": [
    {
      "object": "block",
      "type": "paragraph",
      "paragraph": {
        "rich_text": [{ "text": { "content": "Page content here." } }]
      }
    }
  ]
}

For database rows, use "parent": { "database_id": "<database_id>" } and include the database's required properties.

Updating Pages

Update page properties
PATCH https://api.notion.com/v1/pages/{page_id}
{
  "properties": {
    "Status": { "select": { "name": "Done" } },
    "Due": { "date": { "start": "2024-12-31" } }
  }
}
Append blocks to a page
PATCH https://api.notion.com/v1/blocks/{block_id}/children
{
  "children": [
    {
      "object": "block",
      "type": "paragraph",
      "paragraph": {
        "rich_text": [{ "text": { "content": "Appended content." } }]
      }
    },
    {
      "object": "block",
      "type": "heading_2",
      "heading_2": {
        "rich_text": [{ "text": { "content": "A heading" } }]
      }
    },
    {
      "object": "block",
      "type": "bulleted_list_item",
      "bulleted_list_item": {
        "rich_text": [{ "text": { "content": "A bullet point" } }]
      }
    },
    {
      "object": "block",
      "type": "to_do",
      "to_do": {
        "rich_text": [{ "text": { "content": "A task" } }],
        "checked": false
      }
    }
  ]
}
Update a block's content
PATCH https://api.notion.com/v1/blocks/{block_id}
{
  "paragraph": {
    "rich_text": [{ "text": { "content": "Updated text." } }]
  }
}
Delete (archive) a block
DELETE https://api.notion.com/v1/blocks/{block_id}

Archive / Delete Pages

Notion does not permanently delete pages via the API - it archives them:

PATCH https://api.notion.com/v1/pages/{page_id}
{
  "archived": true
}

Pagination

When a response includes "has_more": true, pass "start_cursor": response.next_cursor in the next request to get the next page of results.

Error Handling

  • 401 Unauthorized: The token is missing, invalid, or expired. For Internal integrations, ask the user to re-run the vellum-oauth-integrations skill. For OAuth connections, the access token may need to be refreshed or re-authorized.
  • 403 Forbidden: The integration doesn't have access to the requested page or database. Remind the user that they need to share the page/database with the "Vellum Assistant" integration in Notion (via the Share menu → "Add connections").
  • 404 Not Found: The page or database ID doesn't exist or the integration can't see it. Verify the ID and check sharing settings.
  • 400 Bad Request: Check the request body structure. The Notion API error response includes a message field with details.
  • 429 Too Many Requests: Wait a few seconds and retry.
  • credential tool policy denied: The credential is missing bash in allowedTools or an injection_templates entry for api.notion.com, so the proxy cannot inject the Authorization header. Switch to Path A (managed OAuth), which bypasses credential metadata requirements entirely.

Tips

  • Notion page IDs in URLs are formatted without hyphens. The API accepts both forms: abc123def456... or abc123de-f456-....
  • When extracting IDs from Notion URLs, strip any query parameters and trailing path components after the 32-character ID segment.
  • Always include Notion-Version: 2022-06-28 header to get stable API behavior.
  • For rich text, concatenate all plain_text values in the array to get the full text content.
  • When creating content with rich text formatting (bold, italic, links), use the annotations and href fields in rich_text objects.

© 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 1 other file (assets) in skills/notion of vellum-ai/vellum-assistant.

  • SKILL.md
  • assets/icon.svg

Open the folder on GitHubat commit 33cc983

Compare with similar skills

Notion 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.

Notion compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Notion this skillvellum-ai/vellum-assistant1.4k—~2.7kAutomated safety check: PassMIT
Notion Worker Third-Party Auth Guidemakenotion/workers-template4391 repos~3.5kAutomated safety check: NotesMIT
Add OAuth Providersuperdesigndev/treg5k—~2.5kAutomated safety check: PassCustom licence
Notion Worker Sync Scaffoldmakenotion/workers-template4391 repos~4.6kAutomated safety check: NotesMIT
Notion Workers Sync Guidemakenotion/workers-template4391 repos~3kAutomated safety check: PassMIT
Notion APIintellectronica/agent-skills2951 repos~3.7kAutomated safety check: PassCC0-1.0

Similar skills

  • Notion Worker Third-Party Auth Guide

    makenotion/workers-template

    Official

    Decides whether a Notion Worker should use a brokered credential, a plaintext environment secret, or OAuth to authenticate against a non-Notion service.

    439 GitHub starsUsed in 1 repo~3.5k tokens
    Backend & APIsAuto-check: notes
  • Add OAuth Provider

    superdesigndev/treg

    Add a provider to treg's OAuth registry (the ones treg holds its own approved app for).

    5k GitHub stars~2.5k tokensUpdated today
    Backend & APIsAuto-check passed
  • Notion Worker Sync Scaffold

    makenotion/workers-template

    Official

    Walks you through designing a new sync for a Notion Worker, covering data source, mode, pagination and cursors, and then generates working code.

    439 GitHub starsUsed in 1 repo~4.6k tokens
    Backend & APIsAuto-check: notes
  • Notion Workers Sync Guide

    makenotion/workers-template

    Official

    Guides the design of Notion Workers syncs, from choosing a simple replace sync or a backfill plus delta pair to pagination, consistency buffers, pacing and deletion handling.

    439 GitHub starsUsed in 1 repo~3k tokens
    Backend & APIsAuto-check passed
  • Notion API

    intellectronica/agent-skills

    This skill provides comprehensive instructions for interacting with the Notion API via REST calls.

    295 GitHub starsUsed in 1 repo~3.7k tokens
    Backend & APIsAuto-check passed
  • Operate Notion Public API through UXC with a curated OpenAPI schema for search, block traversal, page reads, content writes, and data source/database inspection.

    116 GitHub stars~2.3k tokensUpdated 26 days ago
    Backend & APIsAuto-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 yesterday
    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 yesterday
    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 yesterday
    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 yesterday
    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 yesterday
    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 yesterday
    Auto-check: warnings

Works with

Categories

Questions about Notion

What does Notion do?

Read and write Notion pages and databases using the Notion API. Notion is an agent skill from vellum-ai/vellum-assistant.

When should I use Notion?

Notion fits situations like: backend & APIs work in your project.

How do I install Notion in Claude Code?

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

How do I install Notion in Codex?

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

Can I use Notion 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 notion -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/notion, .gemini/skills/notion, .github/skills/notion and .opencode/skills/notion in your project.

What does Notion need to run?

Going by SKILL.md and its folder, Notion needs the command-line tools its instructions call (curl). Compatibility (from SKILL.md): Designed for Vellum personal assistants.

Does Notion access the network?

SKILL.md names 2 domains. In commands or code: api.notion.com and notion.so; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.

Is Notion 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 Notion use?

Notion 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 Notion 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 Notion?

Skills that share tags, products or a category with Notion: Notion Worker Third-Party Auth Guide (makenotion/workers-template, 439 stars), Add OAuth Provider (superdesigndev/treg, 5k stars), Notion Worker Sync Scaffold (makenotion/workers-template, 439 stars) and Notion Workers Sync Guide (makenotion/workers-template, 439 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Notion?

vellum-ai (a GitHub organization) maintains it in vellum-ai/vellum-assistant, which has 1,408 GitHub stars. The repository holds 108 skills in this directory. The repository was last updated on October 9, 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.