Create an API key

1. Open API Keys.
2. Create a key.
3. Choose the SQL connector or the storage connector.
4. Copy the key when it is shown.

Send it on every request:

X-API-KEY: YOUR_API_KEY

An OPTIONS request to https://core.orbitype.com/api with that header returns projectId and connectorId. projectId is the workspace id.

You do not paste the key into node code. orbi.project.apiKeys already contains the keys for this workspace. The field is named project. It is the workspace. Match connectorId when you have more than one.

To get started, go to your project's settings page and generate a new API key.

Each key is scoped to exactly one connector. Make sure to include it in each

request as a custom

X-API-KEY

header. Sending an

HTTP OPTIONS

request to the API

base URL will return the IDs of the project and connector the key is scoped

to.

Make sure to include the API key in your requests as a custom header:

X-API-KEY: your-key-here

You can verify your key’s scope by sending an OPTIONS request:

http request OPTIONS https://core.orbitype.com/api X-API-KEY: your-key-here

The response will contain the workspace and connector IDs:

{ \n  \"projectId\": \"your-project-uuid\", \n  \"connectorId\": \"your-connector-uuid\" \n}

Create

.cursor/mcp.json

and paste:

{
  "mcpServers": {
    "orbitype-sql-prod": {
      "url": "https://core.orbitype.com/api/mcp/v1",
      "headers": {
        "X-API-KEY": "${env:ORBITYPE_SQL_API_KEY_PROD}"
      }
    },
    "orbitype-s3-public-prod": {
      "url": "https://core.orbitype.com/api/mcp/v1",
      "headers": {
        "X-API-KEY": "${env:ORBITYPE_S3_PUBLIC_API_KEY_PROD}"
      }
    },
    "orbitype-s3-private-prod": {
      "url": "https://core.orbitype.com/api/mcp/v1",
      "headers": {
        "X-API-KEY": "${env:ORBITYPE_S3_PRIVATE_API_KEY_PROD}"
      }
    }
  }
}

Open

~/Library/Application Support/Claude/claude_desktop_config.json

and paste into

mcpServers

:

{
  "orbitype-sql-prod": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://core.orbitype.com/api/mcp/v1",
      "--header",
      "X-API-KEY: <SQL_PROD_KEY>"
    ]
  },
  "orbitype-s3-public-prod": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://core.orbitype.com/api/mcp/v1",
      "--header",
      "X-API-KEY: <S3_PUBLIC_PROD_KEY>"
    ]
  },
  "orbitype-s3-private-prod": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://core.orbitype.com/api/mcp/v1",
      "--header",
      "X-API-KEY: <S3_PRIVATE_PROD_KEY>"
    ]
  }
}

Orbitype also exposes MCP on Core:

POST https://core.orbitype.com/api/mcp/v1

Authentication is the same as REST:

X-API-KEY: your-key-here

One API key is bound to one connector. Discovery and tools are automatically scoped to that connector.

Use standard JSON-RPC methods:

initialize

tools/list

tools/call

Recommended first call:

orbitype_get_context

This returns project/connector context, S3 prefix (if applicable), and guidance for safe usage.

Tool names are Cursor-compatible (alphanumeric + underscores):

SQL

sql_readonly_query

sql_crud_execute

S3

s3_list

s3_put

s3_delete

s3_copy

s3_signed_url

Context

orbitype_get_context

For shared buckets, Orbitype enforces connector prefixes server-side for S3 calls.

Paths must start with the connector prefix (for

path

,

from

,

to

). Invalid paths return a JSON-RPC validation error instead of an unclear AWS error.

Some Claude Desktop versions reject remote

url + headers

configs directly. Use

mcp-remote

in

~/Library/Application Support/Claude/claude_desktop_config.json

:

{\n  \"mcpServers\": {\n    \"orbitype-sql-prod\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"-y\",\n        \"mcp-remote\",\n        \"https://core.orbitype.com/api/mcp/v1\",\n        \"--header\",\n        \"X-API-KEY: <SQL_PROD_KEY>\"\n      ]\n    }\n  }\n}

Create or update

.cursor/mcp.json

:

{\n  \"mcpServers\": {\n    \"orbitype-sql-prod\": {\n      \"url\": \"https://core.orbitype.com/api/mcp/v1\",\n      \"headers\": {\n        \"X-API-KEY\": \"${env:ORBITYPE_SQL_API_KEY_PROD}\"\n      }\n    }\n  }\n}

Use separate entries for SQL/S3/public/private keys as needed.

https://developers.openai.com/apps-sdk/deploy/connect-chatgpt

The header must be X-API-KEY. A key works only for its connector. A SQL key cannot read files, and a storage key cannot run SQL. Send OPTIONS to https://core.orbitype.com/api to see projectId and connectorId. projectId is the workspace id.