Server URL
2025-11-25, 2025-06-18, 2025-03-26 and 2024-11-05.
Connect
- Claude
- ChatGPT
- Claude Code
- Codex
- Cursor
Add a custom connector with the server URL, then sign in to SphereScout when Claude asks. See Claude’s guide to custom connectors.
Sign-in and permissions
The server uses OAuth 2.1 with PKCE (S256). Clients register with a Client ID Metadata Document or with Dynamic Client Registration.
When you connect, SphereScout shows which permissions the assistant asks for:
To give an assistant read-only access, untick Start exports that spend your credits on the consent screen. Its export tools then answer
insufficient_scope.
Access tokens last 1 hour. Refresh tokens last 90 days and are replaced each time they’re used. To disconnect an assistant, open Connected apps on the API page of your dashboard.
Clients without OAuth can send a SphereScout API key instead, as Authorization: Bearer YOUR_API_KEY. An API key has both scopes.
Plans and credits
- Searching, counting and previewing work on every account.
- Exports need an active paid subscription. Each exported business costs 1 credit, and an export never costs more than the count the user confirmed.
- Exporting only what changed since a past export needs a plan with data updates.
- If an export fails,
get_exportsays whether its credits were refunded.
Export statuses
Exports run in the background.start_export and start_update_export return a search_id; poll it with get_export every poll_after_seconds (5 seconds).
Errors
A tool that can’t complete a request returns a result withisError: true. Its structuredContent names the error, says whether retrying can help, and gives a message to show the user:
A request without valid credentials gets an HTTP
401 with a WWW-Authenticate header pointing to the OAuth metadata. An unknown tool gets JSON-RPC error -32602.
Limits
Data handling
- Exports are saved to the export history of the account that signed in. The download link is returned only to the connection that started the export. SphereScout also emails the account owner when the file is ready or if the export fails; both emails can be turned off under Email notifications on the plans page of the dashboard. The server never sends files or messages to businesses, CRMs or anyone else.
- Business names, addresses and websites are third-party data. Answers that contain them include a
data_notereminding the assistant not to follow instructions found in them. - The privacy policy describes what SphereScout collects when you use an AI assistant.
Tool reference
Every tool’s inputs, outputs, classification, side effects and errors.
API keys
Create a key for clients that don’t support OAuth.