Developer overview
Build a Beacon connection with the TypeScript SDK, Agent API, or Model Context Protocol.
Beacon provides three developer surfaces. Choose the surface that matches your task.
TypeScript SDK
A software development kit (SDK) provides typed methods for the supported Beacon Agent API.
Use the SDK for a TypeScript application or service. Start with Install the TypeScript SDK.
Read the TypeScript SDK release notes before an upgrade.
Agent API
The Agent API is an application programming interface for direct automation.
It supports identity, channels, calendar reads, post checks, post management, media upload, and selected AI actions.
Read the Agent API reference for the supported routes.
Read Limits and safe testing before integration tests.
Read Publication webhooks to receive signed lifecycle events.
Read the Agent API change policy for compatibility and removal rules.
Model Context Protocol
Model Context Protocol (MCP) lets a compatible AI client use Beacon tools after user approval.
Use MCP when a person wants an AI client to help with Beacon tasks.
Start with Connect through MCP.
Install the portable Beacon skill when your AI agent supports skill files.
Track developer changes
Read the developer changelog for dated Agent API, MCP, skill, and documentation changes.
Choose safe access
Use an agent key for direct automation. Use browser sign-in for a hosted MCP connection.
Grant only the required permissions. Never put a Beacon credential in source code, chat, or logs.
Product and developer coverage
The SDK covers the supported Agent API operations. It does not provide browser-session access to every Beacon screen.
Ideas capture, Board editing, Documents, working-draft context, and linked-idea history currently use the signed-in Beacon interface. They are not Agent API or SDK methods. Creating a post with the SDK does not accept an idea ID or Board selection as source context.
SDK channel results include the account's maxCharacters and xSubscriptionType. Connected X accounts with a confirmed paid subscription can use 25,000 characters. Other X accounts use 280. Use Check a plan to validate copy before generation or publication. Beacon checks X eligibility again before it sends long copy.