Official agent skill

Slack Docs

by slackapi in slackapi/slack-skills-plugin

A skill your agent uses when answering a conceptual or how-to question about Slack platform features, or when asked to look up, fetch, or summarize a docs.slack.dev page, including a pasted…

OfficialMITAuto-check passedDocuments & Office

Install Slack Docs

skills CLI
$ npx skills add slackapi/slack-skills-plugin --skill slack-docs -a claude-code

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

GitHub CLI
$ gh skill install slackapi/slack-skills-plugin slack-docs --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/slackapi/slack-skills-plugin.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/slack-docs .claude/skills/slack-docs && 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
slack-docs
GitHub stars
144
Token cost
~2.2k tokens
SKILL.md length
1,149 words
Files
1
Skills in repo
7
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when answering a conceptual or how-to question about Slack platform features, or when asked to look up, fetch, or summarize a docs.slack.dev page, including a pasted…

  • Works in 3 steps: Discover the Page (search) → Read the Page (fetch markdown) → Tool and SDK Documentation
  • Answering a conceptual
  • SKILL.md covers Fast Path (the developer…, Step 1: Discover the Page…, Step 2: Read the Page (fetch… and Step 3: Tool and SDK…
  • Reaches docs.slack.dev

What it does

Slack Docs is an agent skill from slackapi/slack-skills-plugin, published by the product's own GitHub organization. Use when answering a conceptual or how-to question about Slack platform features, or when asked to look up, fetch, or summarize a docs.slack.dev page, including a pasted docs.slack.dev link. Covers finding and reading official Slack docs as clean markdown.

Its SKILL.md is about 2.2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Documents & Office, covering Markdown. It works with Slack. The repository describes itself as: Claude Code, Codex, Cursor, and npx skills plugin that enables your AI tools with a Slack MCP Server and Slack Developer Skills. The licence is MIT.

When your agent uses it

  • Answering a conceptual
  • How-to question about Slack platform features
  • Asked to look up
  • Summarize a docs.slack.dev page

Example prompts

  • “/slack-docs”

Requirements

  • Python 3

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. Discover the Page (search)
  2. Read the Page (fetch markdown)
  3. Tool and SDK Documentation

What it can do on your machine

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

    No scripts in the folder and no shell commands in SKILL.md (its code samples are json).

    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:

    • docs.slack.dev

    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.

Context cost

Slack Docs loads about 2.2k tokens when it runs. Until then it costs about 67 tokens; SKILL.md has 1,149 words of instructions outside code blocks.

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

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 slackapi/slack-skills-plugin at commit 64c3f33, republished under its MIT licence (© slackapi). 1,149 words, ~2,216 tokens.

Download SKILL.mdSave it as .claude/skills/slack-docs/SKILL.md (or your agent's skills folder).
name
slack-docs
description
Use when answering a conceptual or how-to question about Slack platform features, or when asked to look up, fetch, or summarize a docs.slack.dev page, including a pasted docs.slack.dev link. Covers finding and reading official Slack docs as clean markdown.
argument-hint
[topic or docs.slack.dev URL]

Slack Platform Documentation

Help the developer find the right page on the official Slack documentation site (https://docs.slack.dev) and read it as clean markdown, so answers come from the live docs rather than memory. The site exposes three machine-readable surfaces an agent can use directly, with no authentication and no Slack workspace:

  • A search API method: GET https://docs.slack.dev/api/v1/search?query=<q>&category=<c> returns ranked page hits as JSON. Scope every search with a category (guides, reference, a specific SDK, etc.); an uncategorized search skews heavily toward SDK pages.
  • Per-page markdown: every page is available at its URL + .md (e.g. /quickstart.md).
  • Index files: /llms.txt (a curated overview) and /llms-sitemap.md (a list of every markdown page).

If $0 is provided, it is either a docs.slack.dev URL (jump to the Fast Path) or a topic to search (start at Step 1). For a broad "how do I build X on Slack?" question rather than one specific page, read https://docs.slack.dev/llms.txt first; it is a curated, LLM-oriented overview of the platform and the recommended build path.

Critical rules:

  • The docs are the source of truth. Do not answer a factual question about the Slack platform from memory; discover the page, fetch it, then answer from what it says.
  • Prefer the .md version of any page over the HTML version. It is cleaner for reading and quoting.
  • Every fetched markdown page begins with a Source: <url> line. Keep that URL so you can cite the page back to the developer.

DO NOT rules:

  • DO NOT invent documentation URLs. Get them from the search API, the sitemap, or a link the developer gave you then verify by fetching.
  • DO NOT paraphrase a page you have not actually fetched. If a fetch fails, say so rather than filling the gap from memory.
  • DO NOT assume every URL has a .md version. If a fetch returns an error, fall back to the search API or the sitemap (Step 1) rather than guessing another URL.

Fast Path (the developer already has a URL)

If the developer pasted a https://docs.slack.dev/... link, skip discovery and go straight to Step 2 to fetch and read it.


Use the docs search API to find candidate pages. WebFetch this URL, with the query URL-encoded and a category to scope the results:

text
https://docs.slack.dev/api/v1/search?query=<url-encoded query>&category=<category>&limit=5

Always start with a category. An uncategorized search is dominated by SDK reference pages (a query like socket mode or oauth can return a top 10 that is entirely Bolt/Node pages), which buries the conceptual and reference content most questions are actually about. Pick the starting category from the developer's intent:

  • guides — the default for "how do I…", "what is…", and conceptual platform questions (Events API, OAuth, Socket Mode, manifests, modals, App Home). Start here when in doubt.
  • reference — for a specific method, event, scope, object, or Block Kit element, especially an exact name like chat.postMessage.
  • A tool/SDK category (python, javascript, java, slack_cli, slack_github_action, deno_slack_sdk) — only once you know the developer's tool. See Step 3.

So socket mode as a concept → https://docs.slack.dev/api/v1/search?query=socket%20mode&category=guides&limit=5.

The response is JSON:

json
{
  "total_results": 12,
  "results": [
    { "url": "/apis/events-api/using-socket-mode", "title": "Using Socket Mode" }
  ],
  "limit": 5
}

Scan results for the best title/url match, then read it in Step 2. A query is required; calling the endpoint with no query returns a 400 with an error field.

Full set of categories:

CategoryScopes results to
guidesConceptual and how-to guides
referenceAPI reference: methods, events, scopes, objects, Block Kit
changelogChangelog and release notes
pythonPython tools (Bolt for Python, Python Slack SDK)
javascriptJavaScript tools (Bolt for JS, Node Slack SDK)
javaJava tools (Bolt for Java, Java Slack SDK)
slack_cliSlack CLI docs
slack_github_actionSlack Send GitHub Action docs
deno_slack_sdkDeno Slack SDK docs

If a categorized search returns no good hit, widen it: try the other likely category (guides ⇄ reference), then drop category entirely as a last resort. An unrecognized value returns a 400 with an error field listing the valid categories, so re-run with one of those or with no category.

Fallbacks when search does not surface a good hit, or returns a 500/temporary error (the endpoint is rate-limited and cached ~5 minutes):

  • WebFetch https://docs.slack.dev/llms-sitemap.md, a flat list of every documentation page's .md URL, and scan it for the relevant path.
  • For API reference lookups, the enriched index pages are often faster: https://docs.slack.dev/reference/methods.md, .../events.md, .../scopes.md, .../objects.md, and .../block-kit.md each list every item with a one-line description and a .md link.
  • If the developer has the Slack CLI, slack docs search "<query>" does the same discovery from the terminal (see the slack:slack-cli skill).

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

Step 2: Read the Page (fetch markdown)

Given a page reference (a url from Step 1, or a link the developer pasted), read its markdown:

  1. Normalize the reference to its .md URL:
    • A site-relative path from Step 1 (e.g. /apis/events-api/using-socket-mode): prepend https://docs.slack.dev.
    • A full URL the developer pasted: drop any #anchor first.
    • Append .md, e.g. …/using-socket-mode → https://docs.slack.dev/apis/events-api/using-socket-mode.md. The server lowercases .md requests, so casing does not matter: chat.postMessage.md and chat.postmessage.md both resolve.
  2. WebFetch it. The page opens with Source: <original-url>; the rest is the page body in markdown.
  3. Answer the developer from the fetched content, and cite the Source URL.

If a page is long and the developer asked something narrow, fetch it and quote only the relevant section rather than dumping the whole page.


Step 3: Tool and SDK Documentation

Implementation details differ significantly between the official tools, so establish which one the developer is using first, then scope your reading to that tool's doc subtree. Each lives under https://docs.slack.dev/tools/<name> and its pages are fetchable as .md like any other (e.g. https://docs.slack.dev/tools/bolt-js/concepts.md). If the developer has not said, ask before assuming.

ToolDocs pathSearch categoryUse when the developer…
Slack CLI/tools/slack-clislack_cliscaffolds, runs, or manages an app from the terminal; mentions slack commands or app manifests
Bolt for JavaScript/tools/bolt-jsjavascriptbuilds an app in Node/TypeScript with the Bolt framework
Bolt for Python/tools/bolt-pythonpythonbuilds an app in Python with the Bolt framework
Bolt for Java/tools/java-slack-sdkjavabuilds an app in Java with Bolt (Bolt for Java lives in the Java SDK docs)
Node Slack SDK/tools/node-slack-sdkjavascriptwants lower-level Node clients (@slack/web-api, @slack/socket-mode) without the full Bolt framework
Python Slack SDK/tools/python-slack-sdkpythonwants the lower-level Python client without Bolt
Java Slack SDK/tools/java-slack-sdkjavawants Java clients, or is using Bolt for Java
Slack Send GitHub Action/tools/slack-github-actionslack_github_actionsends data to Slack from a GitHub Actions workflow

Once you know the tool, narrow discovery with the matching category from Step 1, e.g. …?query=middleware&category=javascript. Note the languages group: both Bolt for JavaScript and the Node Slack SDK fall under javascript (likewise python and java each cover their Bolt framework plus lower-level SDK), so the category scopes to the language family, not a single subtree.

Bolt is the framework built upon the matching language SDK. When unsure which subtree a topic lives in, fall back to the search API (Step 1) as it indexes all of these.

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

Files

Just SKILL.md in skills/slack-docs of slackapi/slack-skills-plugin.

Open the folder on GitHubat commit 64c3f33

Compare with similar skills

Slack Docs 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.

Slack Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Slack Docs this skillslackapi/slack-skills-plugin144—~2.2kAutomated safety check: PassMIT
Delivery Routinggrandamenium/cortextos100—~1.5kAutomated safety check: PassMIT
Markdown Article FormatterJimLiu/baoyu-skills26k6 repos~3.5kAutomated safety check: PassMIT
MarkitdownImCa0/just-laws78114 repos~3.2kAutomated safety check: NotesMIT
Obsidian MarkdownAtmosphere/atmosphere3.8k20 repos~1.3kAutomated safety check: PassApache-2.0
Gzh Designisjiamu/gzh-design-skill3.9k1 repos~2.2kAutomated safety check: PassAGPL-3.0

Similar skills

  • Delivery Routing

    grandamenium/cortextos

    Route research summaries to local markdown, Telegram, or Slack with approval gates and delivery-state updates.

    100 GitHub stars~1.5k tokensUpdated 14 days ago
    Documents & OfficeAuto-check passed
  • Markdown Article Formatter

    JimLiu/baoyu-skills

    Reformats plain text or Markdown articles with frontmatter, a title, a summary, headings, bold, lists and code blocks, and saves a separate formatted copy.

    26k GitHub starsUsed in 6 repos~3.5k tokens
    Documents & OfficeAuto-check passed
  • Markitdown

    ImCa0/just-laws

    Convert files and office documents to Markdown. An agent skill from ImCa0/just-laws.

    781 GitHub starsUsed in 14 repos~3.2k tokens
    Documents & OfficeAuto-check: notes
  • Obsidian Markdown

    Atmosphere/atmosphere

    Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.

    3.8k GitHub starsUsed in 20 repos~1.3k tokens
    Documents & OfficeAuto-check passed
  • Gzh Design

    isjiamu/gzh-design-skill

    微信公众号文章排版引擎,将 Markdown 转换为可直接粘贴到公众号编辑器的 HTML。主题风格从 references/theme-index.md 注册的自定义主题库中选取,自动章节编号、关键词下划线标记、引言卡片、目录导航、代码块、图片/GIF、作者签名。支持 Markdown / Word(.docx) / PDF / 纯文本输入(非 Markdown…

    3.9k GitHub starsUsed in 1 repo~2.2k tokens
    Documents & OfficeAuto-check passed
  • Crossposting

    wasp-lang/wasp

    Crosspost Wasp blog articles (MDX) to DEV.to and Medium. An agent skill from wasp-lang/wasp.

    19k GitHub stars~1.1k tokensUpdated today
    Documents & OfficeAuto-check passed

More from slackapi/slack-skills-plugin

  • Block Kit

    slackapi/slack-skills-plugin

    Official

    A skill your agent uses when a developer wants to build or validate Block Kit layouts for Slack messages, modals, or Home tabs: message layouts, modals/forms/dialogs, Home tab interfaces…

    144 GitHub stars~4.5k tokensUpdated today
    Auto-check passed
  • Create Slack App

    slackapi/slack-skills-plugin

    Official

    A skill your agent uses when a developer wants to create, scaffold, or bootstrap a new Slack app or agent from scratch with the Slack CLI.

    144 GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Slack API

    slackapi/slack-skills-plugin

    Official

    A skill your agent uses when a developer asks which Slack Web API method does something, needs a method's OAuth scopes or token type, wants to call or test a family.method endpoint…

    144 GitHub stars~3.3k tokensUpdated today
    Auto-check passed
  • Slack Messaging

    slackapi/slack-skills-plugin

    Official

    A skill your agent uses when writing, drafting, scheduling, or improving a Slack message, announcement, or reply sent via the Slack MCP tools (slacksendmessage, slacksendmessagedraft…

    144 GitHub stars~1.3k tokensUpdated today
    Auto-check passed
  • Slack Search

    slackapi/slack-skills-plugin

    Official

    A skill your agent uses when locating messages, files, channels, or people across Slack, or gathering context before answering, with the search MCP tools (slacksearchpublic…

    144 GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • Test Slack App

    slackapi/slack-skills-plugin

    Official

    A skill your agent uses when a developer wants to test, try out, smoke-test, verify, or confirm that a Slack app built with the Slack CLI (or a plain Bolt app) actually works, by running it in a…

    144 GitHub stars~2.4k tokensUpdated today
    Auto-check: notes

Works with

Questions about Slack Docs

What does Slack Docs do?

A skill your agent uses when answering a conceptual or how-to question about Slack platform features, or when asked to look up, fetch, or summarize a docs.slack.dev page, including a pasted…. Slack Docs is an agent skill from slackapi/slack-skills-plugin, published by the product's own GitHub organization.dev link.

When should I use Slack Docs?

Slack Docs fits situations like: answering a conceptual; how-to question about Slack platform features; asked to look up; summarize a docs.slack.dev page.

How do I install Slack Docs in Claude Code?

Run `npx skills add slackapi/slack-skills-plugin --skill slack-docs -a claude-code`. Or copy the skill folder (skills/slack-docs in slackapi/slack-skills-plugin) into .claude/skills/slack-docs in your project. Claude Code loads it when a task matches its description.

How do I install Slack Docs in Codex?

Run `npx skills add slackapi/slack-skills-plugin --skill slack-docs -a codex`. Or copy the skill folder (skills/slack-docs in slackapi/slack-skills-plugin) into .agents/skills/slack-docs in your project. Codex loads it when a task matches its description.

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

What does Slack Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: Slack Docs is instructions for the agent only. Our summary lists: Python 3.

Does Slack Docs access the network?

SKILL.md names 1 domain. In commands or code: docs.slack.dev; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Slack Docs 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 Slack Docs use?

Slack Docs 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 Slack Docs use?

About 2.2k tokens (SKILL.md is roughly 8.9k 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 Slack Docs?

Skills that share tags, products or a category with Slack Docs: Delivery Routing (grandamenium/cortextos, 100 stars), Markdown Article Formatter (JimLiu/baoyu-skills, 26k stars), Markitdown (ImCa0/just-laws, 781 stars) and Obsidian Markdown (Atmosphere/atmosphere, 3.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Slack Docs?

slackapi (a GitHub organization, an official publisher) maintains it in slackapi/slack-skills-plugin, which has 144 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 6, 2026.

Source: slackapi/slack-skills-plugin on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.