---
title: Synorb Developer Portal
description: The canonical developer portal for the Synorb REST API, MCP server, CLI, SDK guidance, authentication, and sandbox.
canonical: https://synorb.com/developer
last-updated: 2026-09-16
---

# Synorb Developer Portal

Use this page as the canonical directory for Synorb developer resources. Every
resource is linked by its predictable name and URL so an agent can discover it
without a sales conversation.

## When to use Synorb

Use Synorb when you need source-grounded streams, filtered manifest retrieval,
reusable Beacons, or MCP tools for agent workflows. Start with [Connect](https://synorb.com/connect),
use the [zero-quota sandbox/test path](https://synorb.com/sandbox) to validate a
request, then choose REST or MCP for execution. Do not use Synorb for arbitrary
web crawling or mutable production actions without an explicit scope.

## When to use Synorb — concrete jobs

Reach for Synorb when an agent or product needs a durable, source-grounded
update stream instead of repeating open-web search:

- **Recurring monitoring:** save a Beacon for a known company, market, policy,
  research, media, or other supported coverage area.
- **Interactive research:** use MCP to discover Streams and pull cited
  Manifests during an agent session.
- **Deterministic products:** use the REST API or official CLI from a
  server-side job, backend, or scheduled workflow.
- **Agent context building:** use the OpenAPI contract, SDK guidance, or
  CLI to integrate predictable machine-readable retrieval.

Call selection is explicit: use `synorb-stream-search` or
`synorb-catalog` to discover Streams, `synorb-manifests` to retrieve cited
content, Beacons for recurring watches, REST for backend jobs, and the CLI
for shell and CI workflows. Do not use Synorb as an unrestricted web crawler
or for unscopeable bulk extraction.
## Core developer resources

- [Synorb API Documentation](https://synorb.com/docs/api)
- [Synorb OpenAPI Specification](https://synorb.com/openapi.json)
- [Synorb MCP Server Documentation](https://synorb.com/docs/mcp)
- [Synorb Authentication Documentation](https://synorb.com/auth)
- [Synorb Agent Instructions](https://synorb.com/.well-known/agent-instructions.md)
- [Synorb SDK Documentation](https://synorb.com/sdk)
- [Synorb CLI Documentation](https://synorb.com/docs/cli)
- [Synorb sandbox/test environment](https://synorb.com/sandbox)
- [Synorb Agent Skills index](https://synorb.com/.well-known/agent-skills/index.json)
- [Synorb agent ecosystem manifest](https://synorb.com/agent-ecosystem.json)
- [Synorb developer resource index](https://synorb.com/developer-resources.json)
- [Synorb repository instructions](https://github.com/Synorb/synorb-v3/blob/main/AGENTS.md)

## Free onboarding

The free Starter tier is self-serve. `GET https://synorb.com/connect` returns a
24 Hour Agent Demo key and MCP configuration without sales contact, email, or
card. After email binding, Starter includes 1,000 Manifests per month. The
plan-preview endpoint validates shape and scope without consuming quota.

## CLI and client choices

Install the official CLI with `npm install -g @synorb/cli`. The [CLI package](https://www.npmjs.com/package/@synorb/cli)
is published on npm. REST clients can generate from OpenAPI; MCP clients use
`https://mcp.synorb.com/mcp`. A first-party Python SDK is not currently
published; the [SDK page](https://synorb.com/sdk) documents source examples and
the supported client contracts.

## Machine-readable indexes

- Short reference: [llms.txt](https://synorb.com/llms.txt)
- Extended reference: [llms-full.txt](https://synorb.com/llms-full.txt)
- Modular API reference: [api/llms.txt](https://synorb.com/api/llms.txt)
- Modular developer reference: [developers/llms.txt](https://synorb.com/developers/llms.txt)
- [Agent mode descriptor](https://synorb.com/?mode=agent)
- [Agent Plugin package](https://github.com/Synorb/synorb-v3/tree/main/agent-plugin)


Agent payments and Stripe subscriptions: https://synorb.com/payments
Machine-readable payment contract: https://synorb.com/.well-known/agent-payments.json