---
title: "Overview"
description: "typeship turns your OpenAPI or GraphQL spec into the SDK, CLI, and MCP server your users install, and keeps them current with a pull request on every spec change."
url: https://typeship.dev/docs
markdown: https://typeship.dev/docs.md
section: "Get started"
---
> ## Documentation index
> Fetch the complete documentation index at https://typeship.dev/llms.txt (every page, one line each) or the full text at https://typeship.dev/llms-full.txt.
> Append .md to any docs URL, or send Accept: text/markdown, for the markdown twin of that page.

# Overview

typeship turns your OpenAPI or GraphQL spec into the SDK, CLI, and MCP server your users install, and keeps them current with a pull request on every spec change.

> For AI agents: start at https://typeship.dev/agents.md to set typeship up in a repository, and use https://typeship.dev/llms.txt to find any page here.

typeship generates the client-side of your API and maintains it. Point a project at your spec, and typeship produces a typed SDK with zero runtime dependencies in TypeScript, Python, or Go, plus a CLI and an MCP server for the TypeScript package. When the spec changes, typeship regenerates everything and opens a pull request per language with the API changes written out.

Examples use the Acme API throughout, so you will see `acme`, `AcmeClient`, and `ACME_TOKEN`. Your names come from your spec.

## Start here

- [Quickstart](https://typeship.dev/docs/quickstart): Create a project, generate your first package, make a call. Ten minutes.
- [Concepts](https://typeship.dev/docs/concepts): Projects, platforms, languages, generations, and how they fit together.
- [Regeneration](https://typeship.dev/docs/projects/regeneration): How a spec change becomes a pull request, and what is in it.
- [typeship API](https://typeship.dev/docs/typeship-api/api): Drive typeship from a pipeline or an agent.

## What you get

- [SDK](https://typeship.dev/docs/platforms/sdk): Typed results and errors, auto-pagination, retries, hooks, validation, webhooks, streaming. TypeScript, Python, Go.
- [CLI](https://typeship.dev/docs/platforms/cli): Every operation as a command with typed flags and JSON output, plus login, config, docs, and completion.
- [MCP server](https://typeship.dev/docs/platforms/mcp): Every operation as a tool for coding agents, with docs tools and a hosted endpoint.

## Drive typeship itself

- [typeship CLI](https://typeship.dev/docs/cli): npm install -g typeship-ax. Every console action as a command, JSON out, built for agents and pipelines.
- [typeship SDKs](https://typeship.dev/docs/sdks): typeship-ax on npm, typeship on PyPI, github.com/typeship-ax/go. Generated from typeship's own spec.
- [typeship MCP server](https://typeship.dev/docs/typeship-api/mcp): Hosted at typeship.dev/mcp and in the MCP registry as dev.typeship/typeship; local over stdio from the npm package.

## Try it without an account

The [generator on the homepage](https://typeship.dev/) runs on any spec without signing up, capped at one platform and the first 25 operations, and keeps nothing. It is the fastest way to see what your package will look like. Everything that keeps a package current happens in a project.

## Sitemap

[Every page of these docs](https://typeship.dev/llms.txt)
