Skip to main content
One command adds Orbit to your agent. Your agent can then search for people, read source-backed profiles, enrich context, and manage directories.

​
Install

Sign in to Orbit:

​
Add the Orbit skills

Skills teach your agent how to get the most out of Orbit’s tools. Install them into Claude Code, Codex, Cursor, and 70+ other agents with the npx skills CLI:
This installs orbit-directories, which covers organization and directory workflows in depth. Search, profile reads, and enrichment are covered by the tool descriptions on this page.

​
Use an API key instead

Sign-in works for every Orbit feature and needs no key. To use an API key, create one in the developer dashboard with the search:read and profile:read scopes, then pass it as a header:
Keep the key in your shell environment or your client’s secret store. See Authentication for scopes and rotation.
Directory management uses account sign-in, which applies your existing organization and directory permissions. Keys cover search, profile reads, and enrichment.

​
What you can do

The catalog also includes directory tools such as list_directories, create_directory, and upload_directory_csv.

​
Search for people

search_people defaults to candidate_discovery: false, profile_depth: "partial", and limit: 10. The limit ranges from 1 to 20. Use a query, identity signals, or both. Supported signals are email, linkedin_url, usernames, urls, address, and phone.
Use a returned profile_id with get_profile to read the profile again. This read uses the profile-read credit rate. Use enrich_profile with operation: "partial" or "full" to request the profile depth you need. "regenerate" requests fresh work; use it when you intend to refresh a profile.
Search can build profiles. Enrich can build or regenerate profiles. get_profile reads the current person context.

​
Manage directories

The MCP server supports creating and updating directories, member management, directory-scoped search, CSV imports, source progress, access grants, one-time refreshes, directory watchers, and activity feeds. Start with list_directory_organizations and list_directories to choose your target. See Manage directories with MCP for workflows and limits. Read and write permissions are separate: directories.write covers writes, and directories.read covers reads. Your organization role and directory grants still apply. Sign in again to pick up new permissions. Use the REST API for batch enrichment, standalone watchers, and webhooks.

​
Troubleshooting

  • Searches take a while. Search and enrichment run until they reach a result. Allow long-running calls.
  • A call timed out. Set a request_id before a search or enrichment call, then retry with that same ID and the same inputs to resume the same work.
  • HTTP 401. Sign in again, or check that your key is present and current.
  • HTTP 403. The session started with a different key. Reconnect with the key you intend to use.
  • Directory tools are missing. Sign in again to grant directory access.
  • A search finished with completed_with_errors. Keep the results it returned; they are valid.
See Error handling and Rate limits for the underlying API behavior.