# Shipstar

- [Introduction](https://docs.shipstar.ai/introduction.md): Automated product marketing for engineers and agents
- [Quickstart](https://docs.shipstar.ai/quickstart.md): Get started with the Shipstar API in under 5 minutes
- [How Does It Work?](https://docs.shipstar.ai/how-it-works.md): How Shipstar transforms your GitHub commits into polished marketing content
- [Plans & Credits](https://docs.shipstar.ai/plans-and-credits.md): What each plan includes and how generation credits work
- [FAQ](https://docs.shipstar.ai/faq.md): Frequently asked questions about Shipstar
- [Shipstar API Authentication Guide](https://docs.shipstar.ai/guides/authentication.md): Complete guide to authenticating with the Shipstar API
- [Content Guidelines](https://docs.shipstar.ai/guides/content-guidelines.md): Tune how technical generated content reads and what it should focus on or leave out
- [Sandbox Testing Guide](https://docs.shipstar.ai/guides/sandbox-testing.md): How to test your Shipstar integration during development
- [Error Handling Guide](https://docs.shipstar.ai/guides/error-handling.md): How to handle errors from the Shipstar API
- [Show Content on Your Website](https://docs.shipstar.ai/guides/website-integration.md): Three ways to put your published changelog, blog posts, and knowledge base on your own site
- [Sync Your Users into a Mailing List](https://docs.shipstar.ai/guides/sync-mailing-list.md): Keep a Shipstar mailing list in step with your own user base — signup hooks, nightly jobs, Zapier/n8n, and one-off CSV imports
- [Shipstar MCP Server Overview](https://docs.shipstar.ai/mcp/overview.md): Use Shipstar's published content directly from LLM agents via the Model Context Protocol
- [OAuth](https://docs.shipstar.ai/mcp/oauth.md): Connect Shipstar to claude.ai and other MCP clients with OAuth 2.1 — plus protocol details for client builders
- [Set up Shipstar](https://docs.shipstar.ai/mcp/skills/setup-shipstar.md): Claude Code skill that connects the Shipstar MCP server, verifies your project, and audits sources, destinations, and mailing lists so release marketing actually works.
- [Announce a release](https://docs.shipstar.ai/mcp/skills/announce-release.md): Claude Code skill that generates a changelog and release-notes email from your commits, reviews the drafts with you, then publishes and emails subscribers via Shipstar.
- [Write a blog post](https://docs.shipstar.ai/mcp/skills/write-blog-post.md): Claude Code skill that brainstorms blog angles from your commits, generates a draft with Shipstar, revises it with you, and publishes to your blog.
- [Email your users](https://docs.shipstar.ai/mcp/skills/email-your-users.md): Claude Code skill that sends release notes to your mailing lists via Shipstar — with a hard review gate before anything sends and one-click unsubscribe handling.
- [Build a changelog page](https://docs.shipstar.ai/mcp/skills/build-changelog-page.md): Claude Code skill that implements a server-rendered, agent-readable changelog on your own website — semantic HTML that search engines and AI answer engines can read, plus permalinks, RSS, structured data, and the SEO/AEO layer that makes it rank and get cited.
- [Add an announcement banner](https://docs.shipstar.ai/mcp/skills/add-announcement-banner.md): Claude Code skill that puts a Shipstar announcement banner at the top of your website — generated from your commits, reviewed with you, embedded once, and scheduled to update itself weekly or monthly.
- [generate_changelog](https://docs.shipstar.ai/mcp/generation/generate-changelog.md): Kick off a public changelog generation from recent commits
- [generate_blog_post](https://docs.shipstar.ai/mcp/generation/generate-blog-post.md): Kick off a blog post generation from recent commits
- [generate_blog_post_ideas](https://docs.shipstar.ai/mcp/generation/generate-blog-post-ideas.md): Brainstorm blog post angles from recent commits
- [generate_feature_page](https://docs.shipstar.ai/mcp/generation/generate-feature-page.md): Kick off generation of a marketing feature landing page
- [generate_kb_articles](https://docs.shipstar.ai/mcp/generation/generate-kb-articles.md): Kick off generation of knowledge base articles from recent commits
- [generate_featurebase_articles](https://docs.shipstar.ai/mcp/generation/generate-featurebase-articles.md): Kick off generation of Featurebase help-center articles from recent commits
- [generate_release_notes_email](https://docs.shipstar.ai/mcp/generation/generate-release-notes-email.md): Kick off generation of a release notes email from recent commits
- [generate_twitter_thread](https://docs.shipstar.ai/mcp/generation/generate-twitter-thread.md): Kick off generation of an X (Twitter) thread from recent commits
- [generate_linkedin_post](https://docs.shipstar.ai/mcp/generation/generate-linkedin-post.md): Kick off generation of a LinkedIn post from recent commits
- [generate_banner](https://docs.shipstar.ai/mcp/generation/generate-banner.md): Kick off generation of an announcement banner from recent commits
- [get_generation_status](https://docs.shipstar.ai/mcp/lifecycle/get-generation-status.md): Check the status of a content record kicked off by a generate_* tool
- [get_content_draft](https://docs.shipstar.ai/mcp/lifecycle/get-content-draft.md): Read the full draft of a generated content record
- [update_content](https://docs.shipstar.ai/mcp/lifecycle/update-content.md): Revise the draft text and/or category of a generated content record
- [approve_content](https://docs.shipstar.ai/mcp/lifecycle/approve-content.md): Approve generated content for publication
- [publish_content](https://docs.shipstar.ai/mcp/lifecycle/publish-content.md): Publish a completed changelog, blog post, or KB article set directly
- [get_project_context](https://docs.shipstar.ai/mcp/project/get-project-context.md): Describe the project this MCP connection is scoped to
- [list_destinations](https://docs.shipstar.ai/mcp/project/list-destinations.md): List the delivery destinations connected to this project
- [list_mailing_lists](https://docs.shipstar.ai/mcp/project/list-mailing-lists.md): List the project's mailing lists with recipient counts by status
- [create_mailing_list](https://docs.shipstar.ai/mcp/project/create-mailing-list.md): Create a named mailing list in the project
- [upsert_mailing_list_recipients](https://docs.shipstar.ai/mcp/project/upsert-mailing-list-recipients.md): Add or update recipients on a mailing list — idempotent, keyed by external_id or email
- [remove_mailing_list_recipients](https://docs.shipstar.ai/mcp/project/remove-mailing-list-recipients.md): Soft-remove recipients from a mailing list by email or external_id
- [send_release_email](https://docs.shipstar.ai/mcp/email/send-release-email.md): Send a completed release notes email to the selected mailing lists
- [list_changelogs](https://docs.shipstar.ai/mcp/changelog/list-changelogs.md): List the project's published changelogs, newest first
- [get_changelog](https://docs.shipstar.ai/mcp/changelog/get-changelog.md): Fetch a single published changelog by its public slug
- [list_blog_posts](https://docs.shipstar.ai/mcp/blog/list-blog-posts.md): List the project's published blog posts, newest first
- [get_blog_post](https://docs.shipstar.ai/mcp/blog/get-blog-post.md): Fetch a single published blog post by its public slug
- [list_kb_article_sets](https://docs.shipstar.ai/mcp/kb/list-kb-article-sets.md): List the project's published knowledge base article sets, newest first
- [get_kb_article_set](https://docs.shipstar.ai/mcp/kb/get-kb-article-set.md): Fetch a single published knowledge base article set by slug
- [get_banner](https://docs.shipstar.ai/mcp/banner/get-banner.md): Get the project's live announcement banner
- [Shipstar API Overview](https://docs.shipstar.ai/api-reference/overview.md): Shipstar V1 REST API reference — endpoints, authentication, rate limits, and versioning
- [Health Check](https://docs.shipstar.ai/api-reference/health.md): Check V1 API availability
- [Get Current User](https://docs.shipstar.ai/api-reference/authentication.md): Retrieve the profile of the authenticated user
- [Shipstar API Versioning & Deprecation Policy](https://docs.shipstar.ai/api-reference/versioning.md): How the Shipstar API is versioned, what counts as a breaking change, and how deprecations are announced
- [List Published Changelogs](https://docs.shipstar.ai/api-reference/changelog/list-changelogs.md): List all published changelogs, newest first
- [Get Public Changelog](https://docs.shipstar.ai/api-reference/changelog/get-changelog.md): Get a published changelog by its public slug
- [Get Changelog RSS Feed](https://docs.shipstar.ai/api-reference/changelog/changelog-feed.md): Get a published changelog as an RSS 2.0 feed
- [List Published Blog Posts](https://docs.shipstar.ai/api-reference/blog/list-blog-posts.md): List all published blog posts, newest first
- [Get Public Blog Post](https://docs.shipstar.ai/api-reference/blog/get-blog-post.md): Get a published blog post by its public slug
- [Get Blog Post RSS Feed](https://docs.shipstar.ai/api-reference/blog/blog-post-feed.md): Get a published blog post as an RSS 2.0 feed item
- [Get All Blogs RSS Feed](https://docs.shipstar.ai/api-reference/blog/all-blogs-feed.md): Get an RSS 2.0 feed of all published blog posts
- [List Published KB Articles](https://docs.shipstar.ai/api-reference/kb/list-kb-articles.md): List all published knowledge base article sets, newest first
- [Get Public KB Articles](https://docs.shipstar.ai/api-reference/kb/get-kb-articles.md): Get published knowledge base articles by public slug
- [Get Live Banner](https://docs.shipstar.ai/api-reference/banner/get-live-banner.md): Get the announcement banner currently live for a project
- [Get Banner by Slug](https://docs.shipstar.ai/api-reference/banner/get-banner.md): Get a project's live announcement banner by its stable public slug
- [List Mailing Lists](https://docs.shipstar.ai/api-reference/mailing-lists/list-mailing-lists.md): List the mailing lists of your API token's project
- [Create Mailing List](https://docs.shipstar.ai/api-reference/mailing-lists/create-mailing-list.md): Create a named mailing list in your API token's project
- [Get Mailing List](https://docs.shipstar.ai/api-reference/mailing-lists/get-mailing-list.md): One mailing list with recipient counts by status
- [List Recipients](https://docs.shipstar.ai/api-reference/mailing-lists/list-recipients.md): Page through a mailing list's recipients, with status filter and search
- [Upsert Recipients](https://docs.shipstar.ai/api-reference/mailing-lists/upsert-recipients.md): Idempotent add-or-update — the call to sync your user base against
- [Add Recipients](https://docs.shipstar.ai/api-reference/mailing-lists/add-recipients.md): Bulk-add email addresses to a mailing list
- [Remove Recipients](https://docs.shipstar.ai/api-reference/mailing-lists/remove-recipient.md): Take one recipient (or a batch) off a list without erasing their opt-out history
- [Export Recipients](https://docs.shipstar.ai/api-reference/mailing-lists/export-recipients.md): Download a mailing list as CSV


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.