diff --git a/README.md b/README.md index 103a5db..42be3df 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,37 @@ +
+ # substack-mcp +An MCP server for Substack. Read your publication data and manage drafts from your AI agent. No publish or delete by design. + +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE) +[![Language: TypeScript](https://img.shields.io/badge/TypeScript-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/) +[![npm version](https://img.shields.io/npm/v/@conorbronsdon/substack-mcp?style=flat-square)](https://www.npmjs.com/package/@conorbronsdon/substack-mcp) +[![MCP](https://img.shields.io/badge/MCP-Model_Context_Protocol-1f6feb?style=flat-square)](https://modelcontextprotocol.io/) +[![Podcast](https://img.shields.io/badge/Podcast-Chain_of_Thought-purple?style=flat-square)](https://chainofthought.show) +[![X](https://img.shields.io/badge/X-@ConorBronsdon-black?style=flat-square&logo=x)](https://x.com/ConorBronsdon) + +
+ +--- + +![Demo: list_drafts tool call and response](docs/demo.gif) + +An MCP server for Substack that lets AI assistants read your publication data and manage drafts. The draft list shown in the demo above is sample data, not real account values. + +**Safe by design:** This server can create and edit drafts but cannot publish or delete posts. You always review and publish manually through Substack's editor. + substack-mcp MCP server -An MCP server for Substack that lets AI assistants read your publication data and manage drafts. +## About -**Safe by design:** This server can create and edit drafts but cannot publish or delete posts. You always review and publish manually through Substack's editor. +Built and maintained by [Conor Bronsdon](https://github.com/conorbronsdon) for the [Chain of Thought](https://chainofthought.show) podcast production workflow, where it drafts and reviews newsletter posts before a human hits publish. Conor hosts Chain of Thought, a show about AI infrastructure and how practitioners actually build with it. More tools for creators live in [ai-tools-for-creators](https://github.com/conorbronsdon/ai-tools-for-creators). Find Conor on X at [@ConorBronsdon](https://x.com/ConorBronsdon). + +**Sibling MCP servers:** +- [Transistor-MCP](https://github.com/conorbronsdon/Transistor-MCP): manage podcast episodes, analytics, and transcripts on Transistor.fm +- [podcastindex-mcp](https://github.com/conorbronsdon/podcastindex-mcp): search the Podcast Index and track guest appearances ## Tools @@ -133,6 +158,10 @@ SUBSTACK_USER_ID=your-id \ npm start ``` +## Contributing + +Issues and pull requests are welcome. Because this server uses Substack's unofficial API, the most useful contributions are fixes when an endpoint changes. If a tool stops working, open an issue with the tool name and the error. The safe-by-design boundary stays: no publish, no delete, no schedule. + --- ## Disclaimer diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..5ced940 Binary files /dev/null and b/docs/demo.gif differ diff --git a/docs/social-preview.png b/docs/social-preview.png new file mode 100644 index 0000000..3cc832f Binary files /dev/null and b/docs/social-preview.png differ