# Orbit developer resources

Connect to the Orbit MCP server, discover workspace tools, and make safe changes from an AI client.

Orbit is a local project workspace for developers on macOS. Its integration surface is a local MCP (Model Context Protocol) server connected to your installed desktop app. This marketing website does not provide a hosted REST API, OpenAPI document, remote MCP endpoint, or SDK download.

## When to use Orbit

Use Orbit when a user asks you to find context for a saved project, organise related repositories, turn project notes into tasks, update documents, or review saved dependency and repository activity. Read existing workspace content before proposing or making changes. For editing source code, use the user's editor or coding tools against the linked folder.

## Connect an AI client

In the Orbit desktop app, open **Settings → Connections → Connect an AI client**, copy the generated configuration, and add the Orbit server entry to a compatible client's MCP settings. Commands and local paths depend on the installation; never guess a remote URL or reuse another machine's paths. Follow the [Orbit MCP server setup and tool reference](/guide/integrations/mcp/).

Start with `read-workspace-tool` to discover projects, then `read-project-tool` for the intended project's content and current revision. Use the tool definitions returned by the server for current arguments and limits. Keep Orbit running when queuing inspection or provider activity, and reread the relevant section for completed results.

## Editing and access boundaries

Make changes only when the user requests them. Supply the revision returned by the latest read. If a revision conflicts, reread and reconcile the user's intended change. Preserve existing list items when adding tags, folders, repositories, or links: supplying a list replaces it. Existing documents and settings have their own revisions.

Credential setup, vault unlocking, native OS actions, and workspace import or export require the desktop app. MCP cannot reveal secret values, PINs, ciphertext, or connection credentials. A connected AI client may send tool results to its provider; access to a local server does not imply that the client's processing stays local.

## Documentation and support

- [Orbit MCP server](/guide/integrations/mcp/): Setup, tool reference, revisions, and boundaries.
- [Local data](/guide/settings/local-data/): Storage and network requirements.
- [Troubleshooting](/guide/help/troubleshooting/): Common setup problems.
- [Agent resource index](/llms.txt): Markdown links and when-to-use guidance.
- [Contact Orbit](/contact/): Support at support@orbitdesktop.com.

Send `Accept: text/markdown` to this website's page URLs to read Markdown, or follow the alternate Markdown links in each HTML page's head. Browsers continue to receive HTML.