Connect with OAuth
Client setup
Choose your client, add Bulkgrid, and sign in through your browser. Review the workspace and collections the agent can access.- Codex
- Claude Code
- Cursor
- OpenCode
Run in your terminal with the Codex CLI installed:Complete the browser sign-in if prompted. To start sign-in separately, run
codex mcp login bulkgrid. Open a new Codex session after connecting.Codex MCP setup- Open Settings → Connected Apps in Bulkgrid and copy the MCP URL.
- Add a remote MCP server in your AI app. Use OAuth with automatic client registration.
- Sign in to Bulkgrid in the browser, review the preselected workspace, choose collection access, and approve.
- Return to your AI app and enable the Bulkgrid tools.
Permissions
OAuth grantsmcp:use and search:query for the approved workspace and collections. A tool’s collection filter can narrow these permissions but cannot expand them. Your user must remain a member of the workspace.
Each user/client grant stays bound to one workspace, including after reauthorization. Use a separate client connection for another workspace. Manage and revoke access under Settings → Connected Apps.
Search returns passages from indexed content; connecting an app does not automatically ingest new sources. Add sources and check indexing before testing search.
Connect with an API key
For clients configured through bearer headers, create a key withmcp:use and search:query:
x-api-key. Use one authentication method per connection.
The CLI can configure supported clients:
--cursor, --vscode, --claude, or --codex for one client. Each AI app owns its connection; a separate bulkgrid login session does not authenticate the AI app.
Existing installation URLs
Installation-specific URLs have been retired. Replace them with the shared/api/v1/mcp URL and approve access again.
Troubleshooting
Suggested agent instruction
Source management through scoped API keys
The source-management tools in the repository build are available only to API-key connections, withmcp:use plus the operation scopes below. OAuth remains search-only. Tool availability depends on the deployed server version and the key’s scopes; an agent should inspect its connected tools.
Use
analyze_source to start asynchronous analysis, then get_source_analysis to read candidate paths, URL counts and warnings. Analysis can create a crawl run and consume resources. Adding a source can establish ongoing refresh; including it in a collection grants retrieval over its eligible documents. The API enforces workspace, collection and plan restrictions. A key’s technical permissions do not replace the user’s instructions about permitted sources, visibility, scope and budgets.
Success payloads are exposed as structuredContent.result; API failures are tool errors with status and error details. Check source status before describing content as searchable. The bulkgrid-sources skill in the developer repository guides this workflow; bulkgrid-search handles answering from indexed content.