substack-mcp
Health Gecti
- License — License: MIT
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Community trust — 69 GitHub stars
Code Uyari
- network request — Outbound network request in src/api/substack/SubstackApi.js
Permissions Gecti
- Permissions — No dangerous permissions requested
Bu listing icin henuz AI raporu yok.
A Model Context Protocol (MCP) Server for Substack enabling LLM clients to interact with Substack's API for automations like creating posts, managing drafts, and more.
Substack MCP Server
A Model Context Protocol (MCP) Server for Substack enabling LLM clients to interact with Substack's API for automations like creating posts, managing drafts, and more.
Create and publish posts, work with subscribers and analytics, browse your reader feeds, manage
tags and comments, and upload images — 27 tools exposed through one MCP server.
[!IMPORTANT]
Substack does not provide a public API for these operations. This server uses your authenticated
web session. Treat the session token exactly like a password: keep it local, never commit it, and
never include it or a complete Cookie header in a bug report.
Quick start
The fastest installation uses Node.js 22 or newer and npx.
1. Collect your Substack credentials
Sign in to Substack in your browser and open your publication dashboard. You need three values:
- Publication URL — the full base URL of your publication, for example
https://your-publication.substack.com. - Session token — open your browser's developer tools, select Network, filter to
Fetch/XHR, and reload the dashboard. Open a successful authenticated request to your
publication. Under Request Headers, find theCookieheader and locate a session cookie namedsubstack.sidorconnect.sid. Copy its value without the cookie name or the rest of the header.
If both names appear with different values, test them separately and locally with the read-only
verification in step 3; never paste either value into an issue. - User ID — in the same Network panel, search for a successful
publication_userrequest. In
its JSON response, copy the numericidinside theuserobject.
If the browser UI differs, the illustrated credential guide
shows the same requests. If authentication later stops working, sign in again and repeat these steps
to obtain the current token.
2. Add the server to your MCP client
For clients that accept MCP JSON configuration, add:
{
"mcpServers": {
"substack": {
"command": "npx",
"args": ["-y", "substack-mcp@latest"],
"env": {
"SUBSTACK_PUBLICATION_URL": "https://your-publication.substack.com",
"SUBSTACK_SESSION_TOKEN": "your-session-token",
"SUBSTACK_USER_ID": "your-user-id"
}
}
}
}
Replace the three example values, save the configuration, and restart your MCP client. Consult your
client's documentation if it uses a different configuration format.
3. Verify the connection
Ask your client:
List my five most recent Substack drafts.
The client should call list_posts with status: "drafts". If it fails, check the client's MCP
logs and the logging section below before opening an issue.
With Docker installed, use this server configuration:
{
"mcpServers": {
"substack": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "SUBSTACK_PUBLICATION_URL",
"-e", "SUBSTACK_SESSION_TOKEN",
"-e", "SUBSTACK_USER_ID",
"marcomoauro/substack-mcp:latest"
],
"env": {
"SUBSTACK_PUBLICATION_URL": "https://your-publication.substack.com",
"SUBSTACK_SESSION_TOKEN": "your-session-token",
"SUBSTACK_USER_ID": "your-user-id"
}
}
}
}
🛠 Available Tools
create_draft_post - Create a draft postInputs:
title(string): Title of the postsubtitle(string): Subtitle of the postbody(string): Body of the post. Plain text becomes one paragraph per line — Markdown is not
interpreted, so## Headingarrives literally. A JSON string of a Substack document also works
and is validated against the same schemaset_post_bodypublishes, so an unrecognised node name
is an error rather than a silently mangled post.
Returns: {draft_id, is_published}. Pass draft_id to get_draft to read the draft back.
For anything structured — headings, lists, links, code, images, a paywall — use set_post_body
after creating the draft: the schema is published there, so the calling model can read the node
vocabulary rather than guess at it.
Exposes the same filtering the Subscribers dashboard offers: 48 columns, 18 operators, free-text
search, sorting and pagination.
Inputs:
filters(array, optional): conditions combined with AND, each{column, operator, value}search(string, optional): free text matched against subscriber name and emailsort_by(string, optional): any filterable columnsort_direction(asc|desc, optional): defaults todesclimit(number, optional): 1–100, defaults to 25offset(number, optional): for paging
Which operators a column accepts depends on its type:
| Type | Operators |
|---|---|
Int |
is is_not gt gte lt lte |
String |
is is_not is_any_of contains starts_with ends_with includes_none |
DateTime |
is_on is_after is_on_or_after is_before is_on_or_before |
Array (tag_ids, emails_enabled) |
includes_any includes_all includes_none |
subscription_type, group_membership |
is is_not is_any_of |
The columns cover subscriber identity (name, email, country, state, group membership),
subscription (type, start/expiry/cancel dates, revenue, Stripe plan, attribution), email
engagement (opens and unique opens over 7d/30d/6mo, links clicked, sections) and site engagement
(post views, unique posts seen, comments, shares, days active, activity rating). The full list
with types reaches the client in the tool's JSON Schema, so a model does not have to guess names.
Returns: {count, returned, limit, offset, subscribers}. count is the total matching the
filters regardless of limit, so a call with limit: 1 is a cheap way to size a segment.
Note: engagement columns can be filtered on here but are not part of the records this tool
returns — Substack takes the fields it returns from the publication's saved Display settings and
ignores a per-request column list. Useexport_subscribersto read their values.
There is no OR and no nesting: anything needing OR has to be issued as separate calls.
export_subscribers - Export subscribers with every column valueThe way to actually read the engagement metrics list_subscribers can only filter on: email opens
over 7d/30d/6mo, unique emails seen, post views, unique posts seen, comments, shares, links clicked,
days active and activity rating.
Inputs:
filters(array, optional): the same conditions aslist_subscribers, combined with ANDsearch(string, optional): free text matched against subscriber name and emailcolumns(array, optional): which columns to include, defaulting to all of themmax_wait_seconds(number, optional): 1–600, defaulting to 120
Returns: {count, columns, missing_columns, unmapped_columns, export_id, subscribers}, where
each subscriber is keyed by column name.
Substack generates the file asynchronously, so the tool creates a subscriber set, requests the
export, polls until it is ready and downloads it. A small export lands in a few seconds. If the wait
budget runs out the tool says so and names the export_id rather than blocking.
Two caveats, both verified against the live API:
tag_idsandgroup_membershipcannot be exported. Substack drops them silently rather
than failing, so they are reported inmissing_columns— asking for all 48 columns returns 46.- Values arrive display-formatted, not raw: revenue is
"€50.00"here and the number50
throughlist_subscribers. Dates are ISO strings.
There is no paging: an export covers the whole matching set.
list_posts - List drafts, published or scheduled postsInputs:
status(drafts|published|scheduled): which list to readsearch(string, optional): free text matched against title and contentlimit(number, optional): 1–100, defaults to 25offset(number, optional): for pagingsort_direction(asc|desc, optional): drafts and published posts are newest-first,
scheduled posts soonest-first
Returns: {status, total, returned, limit, offset, posts}, each post summarised — useget_draft for the full content of an unpublished one.
Inputs:
draft_id(number): the id returned bylist_postsorcreate_draft_post
Returns: the draft as Substack stores it, body and audience/email settings included.
set_post_body - Replace a draft's body with a structured documentThe only way to write structured content: headings, lists, links, code blocks, quotes, images,
buttons and a paywall. create_draft_post takes plain text; this takes the document Substack
actually stores, and its schema is published in tools/list so the calling model can read the node
vocabulary instead of guessing.
Inputs:
draft_id(number): the id returned bylist_postsorcreate_draft_postbody(object): a Substack ProseMirror document —{type: 'doc', content: [...]}
Fifteen node types are accepted: paragraph, heading, bullet_list, ordered_list, list_item,blockquote, highlighted_code_block, code_block, horizontal_rule, captionedImage, button,paywall, youtube2, plus digestPostEmbed, substack_mentions and directMessage passed through
unchanged so a document read with get_draft can be written back. Marks: strong, em, code,strikethrough, link.
Returns: {draft_id, nodes}, where nodes counts what was stored by type — so a caller that
asked for a paywall can confirm there is one. Validation cannot report a node that was never sent.
Three things worth knowing:
- An image must already be hosted by Substack.
image2.srcpointing at an external URL is
stored but does not render. Useupload_imageto re-host one and get asrcthat works. - A document may contain at most one
paywall. Substack accepts two and renders both, leaving
it undefined which one cuts the post, so this tool refuses the second. ordered_listnumbers fromattrs.order, notattrs.start. A list given onlystart
renders from 1 with no error.
Substack's editor uploads images as base64 data URIs to POST /api/v1/image, which answers with a
Substack-hosted URL. image2.src in set_post_body and cover_image in update_draft only render
such a URL, so this tool is the bridge. Substack itself only re-fetches URLs already in its own
storage, so the image is encoded here rather than being handed off.
Inputs — exactly one of url or path:
url(string): the http(s) URL of an image to download and re-hostpath(string): absolute path to an image file on the machine running this server, read straight
from disk with no downloadpost_id(number, optional): the post the image belongs to; its effect is unconfirmed
Returns: {id, url, content_type, bytes, width, height} — put url into an image2.src when
calling set_post_body, or into cover_image when calling update_draft.
A download is guarded: only http/https, private and loopback hosts are refused after DNS
resolution (redirects are re-checked at every hop), the content type must be an image, HEIC is
rejected with a note to convert it, and the image may not exceed 10 MB.
A local file is guarded differently, because it has no Content-Type header to trust. The path
must be absolute — a relative one would resolve against this server's working directory, not the
calling client's — and the type is read from the file's magic bytes rather than its extension, so a
non-image with an image extension is caught here instead of at Substack. PNG, JPEG, GIF and WebP are
accepted; HEIC and SVG are not. The same 10 MB cap applies, checked against the file size before the
file is read. Note that path reads whatever absolute path it is given: if that matters in your
setup, do not expose this server to a client you would not trust with your filesystem.
The update is partial: only the fields you pass change, and the body is left alone.
Inputs:
draft_id(number): the id returned bylist_postsorcreate_draft_postdraft_title(string, optional)draft_subtitle(string, optional)audience(everyone|only_paid|only_free|founding, optional)write_comment_permissions(everyone|subscribers|only_paid|none, optional): who may commentdefault_comment_sort(best_first|most_recent_first|oldest_first, optional)cover_image(string, optional): the social preview image. A URL already onsubstack-post-media.s3.amazonaws.comorsubstackcdn.comis used as-is; anything else is downloaded and re-hosted on Substack first, under the same guards asupload_imagesocial_title(string, optional): the title used when the post is shared elsewheredescription(string, optional): the social preview description — not the subtitlesearch_engine_title(string, optional)search_engine_description(string, optional)slug(string, optional): the post's URL slug
Returns: {draft_id, updated_fields, draft_title, draft_subtitle, audience, is_published, cover_image, cover_image_rehosted_from}.
A call with no field to change is refused rather than sent as a no-op. cover_image is the URL that
actually landed, which differs from the one passed when it was re-hosted.
Inputs:
draft_id(number): the id returned bylist_postsorcreate_draft_postsend(boolean, optional): email the post to subscribers. Defaults tofalse, unlike the
Substack API's own default — the post goes live on the web either way, but an email cannot be
recalled, so it has to be asked for explicitly.
Returns: {status, draft_id, post_id, title, slug, canonical_url, emailed, email_sent_at}.emailed is what was asked for; email_sent_at is the server's own record of whether it mailed.
The email intent is written to the draft's should_send_email before publishing, as well as being
passed on the publish call. That field is where the dashboard keeps the decision and it defaults totrue, so setting only one of the two would risk mailing the whole list if the endpoint reads the
draft rather than the request body.
There is no unpublish tool: publishing cannot be undone from this server.
delete_draft - Delete an unpublished draftInputs:
draft_id(number): the id returned bylist_postsorcreate_draft_post
Returns: {status, draft_id, draft_title}.
Substack deletes drafts and published posts through the same endpoint, so this tool reads the
target first and refuses if it is published — removing a live post is irreversible and is left
to the dashboard.
Inputs:
full(boolean, optional): return all 111 fields (~24 KB) instead of the projection.
Defaults tofalse.
Returns: by default a projection — name, subdomain, custom domain, hero text, copyright, sender
name, logo, plans, payment state and the community/podcast flags — plus _meta naming how many
fields were dropped. The full payload is mostly notification toggles and the raw HTML of the welcome
email, terms and privacy pages.
Inputs:
full(boolean, optional): include the completesubscriptionsarray. Defaults tofalse.
Returns: {id, name, handle, bio, photo_url, publications, primary_publication_id, subscription_count}. publications lists every publication the session has a role on, which is how
to discover that SUBSTACK_PUBLICATION_URL is not the only one it could be pointed at.
Inputs:
include_hidden(boolean, optional): include tags not shown in the navigation. Defaults totrue.
Returns: {total, returned, tags}, each {id, name, slug, hidden}. Tag ids are UUIDs, not
integers — unlike every other id in this API.
Inputs:
post_id(number): the id fromlist_posts. Works for drafts too.
Returns: {post_id, count, tags}, each {post_tag_id, name, slug, hidden, association_id}.
The underlying endpoint answers only UUIDs, so this resolves the names against the publication's tag
list. Neither get_draft nor list_posts carries tags, so this is the only way to read them back.
Inputs:
post_id(number): the id fromlist_posts. Works for drafts too.tag_name(string): matched case-insensitively against existing tagscreate_if_missing(boolean, optional): create the tag when no name matches. Defaults totrue;
set it tofalseto have a typo reported instead of turned into a new tag.
Returns: {status, post_id, tag, tag_created, association_id} where status is tagged oralready_tagged — re-adding a tag the post already has answers a bare 400 upstream, so it is
checked first.
Takes a name rather than an id because the ids are UUIDs, which no caller could reasonably hold.
get_post_comments - Read the comments on one of your postsInputs:
post_id(number): the id fromlist_postslimit(number, optional): 1–100, defaults to 50
Returns: {post_id, returned, automod_hidden_count, comments}. Each comment carries its author,
plain-text body, reaction and reply counts, and its position in the thread (parent_comment_id,depth). Comments withheld by Substack's automod are counted, not merged in — they arrive in a
separate array upstream, and dropping them silently would turn "held" into "nobody commented".
Inputs:
post_id(number): the id fromlist_postsbody(string): plain text; Substack converts it server-side
Returns: {status, post_id, comment}.
This is published under your name. The full text is logged at info before the request, since the log
is the only record of what was said. This server does not expose deletion, but the comment can be
removed from the Substack UI — unlike a restack, a comment does have an id of its own.
The seven tools below read substack.com, not your publication. They are about the account as a
reader — what it subscribes to, what is in its inbox and feed — which is a different host and a
different id space from the publisher surface above.
Inputs:
limit(number, optional): 1–500, defaults to 100active_only(boolean, optional): exclude paused and expired subscriptions. Defaults totrue.
Returns: {returned, pages_fetched, subscriptions}, each with plan, membership_state,is_founding, is_favorite and whether emails are off. Pages internally up to 20 requests and saystruncated: true if that bound is what stopped it.
Not to be confused with list_subscribers, which is who subscribes to you.
Inputs:
limit(number, optional): 1–100, defaults to 20after(string, optional): thenext_afterfrom a previous response. A timestamp, not an
opaque cursor — this endpoint's owncursorfield is always null.
Returns: {returned, more, next_after, posts}, each post summarised with its reading state
(is_read, read_progress, is_saved). The Inbox sends every post's full body; it is dropped here,
so use get_reader_post to read one.
Inputs:
post_id(number): fromlist_reader_postsorget_reader_feedinclude_body(boolean, optional): defaults totrue
Returns: the post's metadata plus body_html. body_truncated: true means the body was withheld
behind a paywall this session does not clear — preview_text still carries the teaser.
The body stays HTML: converting it would mean a new dependency or a regex pass over markup, and a
regex HTML converter mangles nested lists and embeds silently.
Inputs:
tab(string, optional): tab id —for-you(default) orsubscribed. Never the display name:
those are localized.limit(number, optional): 1–50, defaults to 20cursor(string, optional): thenext_cursorfrom a previous responseinclude_tabs(boolean, optional): also return the available tab ids
Returns: {tab, returned, next_cursor, items}. Each item is a note or a post.non_content_items_skipped counts the "people to follow" blocks Substack mixes into the array, which
carry no content at all.
Inputs:
user_id(number, optional): defaults toSUBSTACK_USER_ID— your own accounttype(all|notes|posts, optional): defaults toalllimit(number, optional): 1–50, defaults to 20cursor(string, optional)
Returns: {user_id, type, returned, next_cursor, items}. When filtering, read_from_profile
reports how many entries the page actually held — otherwise "3 notes out of 20 entries read" would
look like "this account has written 3 notes".
Inputs:
comment_id(number): without thec-prefix Substack uses in urlsinclude_replies(boolean, optional): defaults totrue
Returns: {comment, branch_count, replies_returned, more_branches, next_cursor, branches}. Each
branch is a direct reply plus its descendants, with parent_comment_id and depth resolved.
Inputs:
comment_id(number): the Note to restack, fromget_reader_feedorget_profile_feedtab_id(string, optional): defaults tofor-you
Returns: {status, comment_id, restack_id, note}.
This is public and appears on your profile, and cannot be undone from here: a restack has no id of
its own — it surfaces the original Note with context: comment_restack — so there is nothing for this
server to delete. Remove it from the Substack UI.
Notes only. Restacking a post is not offered: that call answers 404 even for a published post on
your own publication, so a post_id parameter would produce an error that reads as the post being
gone rather than as the tool being wrong.
Inputs: none.
Returns: total and recent subscribers, email and app subscribers, ARR, site views and the
30-day email open rate, each with its change where Substack reports one. If one of the underlying
endpoints fails the rest are still returned, and the failure is named under errors.
For anything deeper, use get_analytics.
Which post actually grew the list, which was worth most, which cost you subscribers. The dashboard's
"Posts" tab, sortable and paged.
Inputs:
order_by(string, optional): any of the 43 metrics, defaulting topost_dateorder_direction(asc|desc, optional): defaults todesclimit(number, optional): 1–100, defaults to 25offset(number, optional): for paging the archive
The metrics worth reaching for:
| group | fields |
|---|---|
| conversion | signups subscribes founding_subscribes annual_subscribes monthly_subscribes free_trials free_to_paid_upgrades signups_within_1_day estimated_value |
| churn | unsubscribes |
| reading | opens open_rate clicks click_through_rate views subscribers_finished_post |
| social | likes shares restacks engagement_rate unique_engagements |
| delivery | queued sent delivered dropped |
| video / podcast | video_views video_minutes_watched downloads downloads_day30 … |
Returns: {total, returned, limit, offset, order_by, order_direction, posts}. total is the
whole archive, not the page; order_by and order_direction are echoed so a ranking is never read
without knowing what produced it.
get_analytics - Read one of 16 publication-level reportsTwo caveats, both verified:
- There is no date filter.
from_date/to_dateare ignored by this endpoint —totaldoes not
change — so the schema does not offer them. Narrow by sorting and paging instead.- Ranking by a rate (
open_rate,engagement_rate,click_through_rate) descending puts posts
with no data first, becausenullsorts before numbers. The tool does not filter them out, since
that would silently answer a different question.
order_byis an enum on purpose: the API answers200for a field it does not recognise and
returns an arbitrary order, so a typo would produce a ranking that looks authoritative.
Everything behind the dashboard's Stats tabs, as one tool with a report enum rather than
seventeen near-identical tools.
Inputs:
report(string): which report to read — see the table belowfrom_date,to_date(string, optional):YYYY-MM-DD. Used only by the reports covering a
period, which default to the last 30 dayslimit(number, optional): 1–100, used only byaudience_overlapandsubscriber_notes
| report | what it tells you |
|---|---|
retention |
cohort retention — how much of each signup cohort is still subscribed months later |
retention_summary |
headline retention at 1, 6 and 12 months |
unsubscribes / unsubscribes_timeseries |
churn, with the reasons given |
growth_sources |
where new subscribers came from, ranked |
growth_events |
the individual growth events in a window |
referrals_leaderboard / referrals_summary |
who refers most; gifts sent, accepted, converted |
audience_overlap |
other Substacks whose audience overlaps yours — the collaboration shortlist |
audience_locations |
how many countries and US states your subscribers span |
subscriber_notes |
recent Notes written by your subscribers |
paid_subscriber_growth |
paid growth rate, new subscriptions, expirations |
subscribers_timeseries, followers_timeseries, arr_timeseries |
counts and revenue over time |
network_attribution |
what share of subscribers arrived via the Substack network |
Returns: {report, params, ignored_params, data}. params is what was actually sent, defaults
included — the same report answers very differently over a different window, so the numbers mean
little without it. ignored_params names anything you passed that the chosen report does not
accept, rather than dropping it silently.
Two neighbouring endpoints are deliberately not exposed:
audience_insights/location(the
subscriber map) andvisitor_sourcesanswer400even for Substack's own dashboard, so they are
broken upstream rather than mis-called.
🏗 Running from Source
Use this if you want to hack on the server itself. There is no build step — the sources are plain
ESM and run as they are.
Node.js
git clone https://github.com/marcomoauro/substack-mcp.git
cd substack-mcp
npm ci
Then add to your MCP config:
{
"mcpServers": {
"substack-api": {
"command": "node",
"args": ["<FULL_PATH_TO_PROJECT>/src/index.js"],
"env": {
"SUBSTACK_PUBLICATION_URL": "<YOUR_PUBLICATION_URL>",
"SUBSTACK_SESSION_TOKEN": "<YOUR_SESSION_TOKEN>",
"SUBSTACK_USER_ID": "<YOUR_USER_ID>"
}
}
}
}
Docker
git clone https://github.com/marcomoauro/substack-mcp.git
cd substack-mcp
docker build -t substack-mcp .
Then add to your MCP config:
{
"mcpServers": {
"substack-api": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "SUBSTACK_PUBLICATION_URL",
"-e", "SUBSTACK_SESSION_TOKEN",
"-e", "SUBSTACK_USER_ID",
"substack-mcp"
],
"env": {
"SUBSTACK_PUBLICATION_URL": "<YOUR_PUBLICATION_URL>",
"SUBSTACK_SESSION_TOKEN": "<YOUR_SESSION_TOKEN>",
"SUBSTACK_USER_ID": "<YOUR_USER_ID>"
}
}
}
}
🪵 Logs
The server logs what it does as one JSON object per line, on stderr — MCP clients collect it
into their own log file (on macOS, Claude Desktop writes it to~/Library/Logs/Claude/mcp-server-substack-api.log). It is the fastest way to see what your LLM
actually sent when a call does not do what you expected:
{"ts":"2026-08-07T10:12:03.114Z","level":"info","msg":"tool.call.start","tool":"create_draft_post","args":{"title":"My title","subtitle":"My subtitle","body":"…"}}
{"ts":"2026-08-07T10:12:03.402Z","level":"info","msg":"substack.response","status":200,"duration_ms":287}
{"ts":"2026-08-07T10:12:03.403Z","level":"info","msg":"create_draft_post.created","draft_id":167712345}
Set the optional SUBSTACK_MCP_LOG_LEVEL env var alongside your credentials to change how much
is written:
| Value | What you get |
|---|---|
silent |
nothing |
error |
failed calls only |
warn |
the above, plus every answer the client received as an error — including calls rejected for bad arguments before they ran |
info (default) |
the above, plus every tool call, request and response |
debug |
the above, plus full payloads and every JSON-RPC message |
Your session token is never written to the log, at any level.
💻 Popular MCP clients
For a complete list of MCP clients and their feature support, visit the official MCP clients page.
| Client | Description |
|---|---|
| Claude Desktop | Desktop application for Claude AI |
| Cursor | AI-first code editor |
| Cline for VS Code | VS Code extension for AI assistance |
| GitHub Copilot MCP | VS Code extension for GitHub Copilot MCP integration |
| Windsurf | AI-powered code editor and development environment |
🆘 Support
- For issues with this MCP Server: Open an issue on GitHub
Yorumlar (0)
Yorum birakmak icin giris yap.
Yorum birakSonuc bulunamadi