Back to Directory/Documentation

Typeship

Generate a typed SDK, CLI, and MCP server from any OpenAPI or GraphQL spec, and keep them current.

DocumentationTypeScriptv0.23.0

@typeship-ax/mcp

MCP server for typeship. API reference

Generated from the OpenAPI spec by typeship. Change the spec or generation settings, then regenerate; generated files are not hand-edited.

  • Zero runtime dependencies — built on the platform fetch in Node 18+
  • Agent-ready MCP — schema-derived tools, argument validation, read-only mode, and bounded results

Build from source

Run these commands in the downloaded or cloned package directory:

npm install
npm run build

Requires Node.js 18+. The package is ESM.

To run the local MCP server, configure your MCP client with node and the absolute path to dist/mcp.js, as shown below. The server communicates over stdio.

Install a published package

Generation does not publish a package. Before using the registry command below, confirm name and version in package.json, publish under a name you control, and verify that release is available on npm.

npm install --global @typeship-ax/mcp@0.10.0

Connect after publishing

The npm connections below require @typeship-ax/mcp to be published under your package identity. To use downloaded source before publishing, use the local configuration in the next section. Hosted connections require a deployed server.

Authentication: provide TYPESHIP_TOKEN through the MCP client's environment or secret settings. Keep credential values out of URLs and command arguments.

Cursor: Cursor 3.2 is not supported: it opens with the legacy initialize handshake, while this server speaks MCP 2026-07-28.

Local

  • Claude Code: claude mcp add typeship -- npx -y --package @typeship-ax/mcp typeship-mcp
  • Codex: codex mcp add typeship -- npx -y --package @typeship-ax/mcp typeship-mcp
  • Install in VS Code

Local · read-only

  • Claude Code: claude mcp add typeship-readonly -- npx -y --package @typeship-ax/mcp typeship-mcp --read-only
  • Codex: codex mcp add typeship-readonly -- npx -y --package @typeship-ax/mcp typeship-mcp --read-only
  • Install in VS Code

Hosted

  • Claude Code: claude mcp add --transport http typeship https://typeship.dev/mcp
  • Codex: codex mcp add typeship --url https://typeship.dev/mcp
  • Install in VS Code

Hosted · read-only

  • Claude Code: claude mcp add --transport http typeship-readonly https://typeship.dev/mcp/readonly
  • Codex: codex mcp add typeship-readonly --url https://typeship.dev/mcp/readonly
  • Install in VS Code

MCP server

A zero-dependency stdio server exposing a compact discovery surface: search_docs, read_docs, and execute. Read an operation before executing it to get its complete schema, example arguments, and safety classification. After building, add the local server to an MCP client:

{
  "mcpServers": {
    "typeship": {
      "command": "node",
      "args": [
        "/absolute/path/to/package/dist/mcp.js"
      ],
      "env": {
        "TYPESHIP_TOKEN": "replace-with-your-credential"
      }
    }
  }
}

Replace the path with the absolute path to this package's built dist/mcp.js.

Replace the credential placeholder using the MCP client's secret storage when it has one. The local server reads TYPESHIP_TOKEN from its environment; credentials never belong in command arguments. If you also generated the CLI, its typeship login command stores credentials the local MCP server can reuse.

Tool input schemas are derived from the OpenAPI spec, so agents see real parameter types and required fields. Arguments are checked before anything reaches the API (unknown or mistyped ones come back as one isError result, nothing is dropped), every tool takes fields to keep only the result keys it needs, and errors carry a stable code and next_steps.

Add --read-only to args (or set TYPESHIP_MCP_READ_ONLY=1) for a server that cannot write, --tools generate,projects (or TYPESHIP_MCP_TOOLS) to expose a subset, and TYPESHIP_MCP_MAX_RESULT_CHARS to change the result size cap (64,000).

MCP Registry

server.json describes the npm executable and any hosted transports. Its dev.typeship/typeship identity matches package.json#mcpName.

Install the official mcp-publisher, publish this npm package first, then validate or publish the listing:

npm run mcp:validate
npm run mcp:publish

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
npx -y @typeship-ax/mcp

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "dev-typeship-typeship": {
      "command": "npx",
      "args": [
        "-y",
        "@typeship-ax/mcp"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

@typeship-ax/mcpnpm

Compatible MCP Clients

Typeship works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More