---
title: Synorb SDK Documentation
description: Synorb REST, MCP, CLI, and SDK guidance for agent developers.
canonical: https://synorb.com/sdk
last-updated: 2026-09-20
---

# Synorb SDK Documentation

Choose the client surface that matches the job. The current Synorb contract uses
one Bearer **Synorb Key** for REST and MCP, with OAuth 2.0 access tokens as an
alternative agent credential sent in the same `Authorization: Bearer` header.

## Current client surfaces

- [Synorb OpenAPI Specification](https://synorb.com/openapi.json) — generate a
  typed REST client for any supported language.
- [Synorb MCP Server Documentation](https://synorb.com/docs/mcp) — use the
  Streamable HTTP server for interactive agent sessions.
- [Synorb CLI Documentation](https://synorb.com/docs/cli) — install the
  official npm package with `npm install -g @synorb/cli`.
- [Synorb Authentication Documentation](https://synorb.com/auth) — provision and
  protect the Synorb Key, or mint scoped OAuth 2.0 tokens.

## Python and other languages

The official Python client is published on PyPI:

```
pip install synorb
```

Source and changelog: [Synorb Python SDK](https://pypi.org/project/synorb/). It
has zero dependencies and speaks the current Synorb Key REST contract. You can
still generate a client from the
[Synorb OpenAPI Specification](https://synorb.com/openapi.json) if you prefer.

Not to be confused with the repository `sdk/` package, which is a legacy,
source-only sync-ontology helper and is not a Synorb Key client.

## Python SDK release notes

- **0.1.1** — metadata fix. The `Repository` and `Changelog` links on the PyPI
  page pointed into a private repository and returned 404 to everyone; they are
  gone and this page is the canonical release-notes location. No code changes.
- **0.1.0** — first release. `SynorbClient` accepting a Synorb Key or an OAuth
  2.0 access token, the read surface mirroring `@synorb/cli`, PKCE helpers in
  `synorb.oauth`, and `connect()` for a free 72-hour demo key with 25
  Manifests. Zero
  dependencies.

## When to use each surface

Use MCP for interactive discovery and reasoning, REST/OpenAPI for deterministic
server-side jobs, and the CLI for local scripts or agent shells. Start with the
[Synorb Developer Portal](https://synorb.com/developer), get a key with
`POST https://api.synorb.com/api/connect/demo-key` (or the button on
[/connect/start](https://synorb.com/connect/start)), and validate request scope through the
[zero-usage sandbox/test path](https://synorb.com/sandbox).