Docs
API Reference

Connect with MCP

Connect the public GridWonk plugin and use authorized research, intake, and review tools.

title: MCP API description: Public and admin Model Context Protocol endpoints for GridWonk tools, docs, jobs, and work-item continuity. last-updated: "2026-10-27"

Model Context Protocol (MCP) lets an AI client use GridWonk tools. The hosted endpoint is https://gridwonk.com/api/v1/mcp. Authentication and current workspace permissions are required for customer operations. Interactive sign-in uses identity scopes; machine integrations use the partner scopes advertised by their separate authorization server.

Organization access and setup

Open Integrations in the selected organization workspace to inspect access and connection setup: /console/integrations, /utility/integrations, or /consultant/integrations. Platform administrators enable organization API/MCP access. Owners/admins can create organization runtime keys when self-service key creation is also enabled. Enabling access does not supply a credential or complete a client's sign-in flow.

Active MCP connections, including curated customer OAuth connections, obey the organization's current API/MCP access choices and suspensions. Disabling MCP refuses subsequent MCP calls while permitted REST calls continue; disabling API blocks both. Revocation remains available on the website. Existing data scopes, membership checks and processing budgets still apply, and the curated customer's processing accounting remains separate from legacy API usage.

Claude Desktop and Codex Desktop are the selected live connection acceptance targets. The setup UI and local tests do not establish live-client acceptance or public plugin publication. Pending organization-free setup remains separate from authorization to execute customer operations.

Public GridWonk plugin

The public package is GridWonk, with package ID gridwonk-connect and server name gridwonk-customer. Availability depends on the public rollout and your client's approved connection support. The chat tool also needs the MCP assistant turned on for your organization, which is off by default during the staged release. It does not require a private repository or a GridWonk administrator account.

  1. Complete account and workspace setup.
  2. Install the public plugin when it is available and sign in with your own GridWonk account.
  3. If connection_status reports CONNECTION_REQUIRED, open its setup link in the browser.
  4. Confirm the workspace as the same signed-in user, then retry your request in the client.

The connection binds that exact session to one workspace. A browser workspace switch cannot retarget it. Connected apps explains revocation, replacement, and recovery. Expired or revoked access cannot be repaired by guessing another workspace ID.

Stable customer catalog

The public plugin exposes a fixed catalog of 38 tools, including connection_status. It stays the same before and after connection setup. A pending session can inspect the available schemas and connection status; ordinary operations return a setup instruction until activation. Tool availability does not itself grant permission.

WorkflowCustomer scope
Documentation and researchPublic help and published utility requirements
Developer preparationAuthorized draft projects and supported packet intake
ProcessingEligible review starts, status, and cited results within current allowances
Utility workAuthorized application, package, finding, history, and notice reads; eligible intake and reviews
RecoverySupported status and recovery operations, with current authority rechecked

The website handles document-role decisions, submission and resubmission, utility adjudication, notice writes and sending, team administration, and purchases. The customer catalog excludes unrestricted chat and generic job execution. A completed review is decision support, not utility approval.

Safe client behavior

Use returned identifiers and schemas; do not invent project, utility, job, or document IDs. Keep uploads within the current intake limits and follow the returned upload/status workflow. Do not use retired inline base64 document uploads. Poll with bounded retries and honor Retry-After. A pending or uncertain processing result is not permission to start a duplicate paid operation. Never place access tokens or signed upload URLs in chat transcripts or logs.

The server checks the current signed session, connection, membership, role, legal acceptance, and processing eligibility on each use. Public documentation access does not grant data access. See processing allowances.

If a request returns legal_acceptance_required, open the supplied acceptance link and accept the updated legal documents in your browser, then retry with the same connection.

Existing partner integrations

Existing organization credentials retain their own authorized catalog and scope rules. The public plugin's browser-bound connection does not replace an organization's integration key. Use API authentication, the API overview, and the utility lane guide for those integrations. Full discovery documents and internal operator tools remain protected; they are not the public plugin contract.

Workspace appearance

Organization admins preview and save source-palette color schemes in the signed-in website. Appearance discovery and saving have no public or Admin MCP mutation tool. Finding logo colors does not approve a logo for display. See organization settings.

On this page