API-Authentifizierung
Orbitype stellt eine vollwertige RESTful API bereit, die du in deinem Code nutzen kannst.
Mit einfachen HTTP-Requests kannst du Daten lesen, erstellen, aktualisieren und löschen.
TABLE_OF_CONTENTS
Erste Schritte
Um loszulegen, gehe auf die Einstellungsseite deines Projekts und erstelle einen neuen API-Schlüssel.
Jeder Schlüssel ist genau einem Connector zugeordnet. Stelle sicher, dass du ihn in jeder
Anfrage als benutzerdefinierten
X-API-KEYHeader mit sendest.
Ein
HTTP OPTIONSRequest an die API-Base-URL gibt die IDs des Projekts und des Connectors zurück, denen der Schlüssel zugeordnet ist.
Authentifizierungs-Header
Vergiss nicht, deinen API-Schlüssel als benutzerdefinierten Header in jeder Anfrage zu setzen:
X-API-KEY: dein-schlüssel-hierDu kannst den Gültigkeitsbereich deines Schlüssels mit einer OPTIONS-Anfrage überprüfen:
http request OPTIONS https://core.orbitype.com/api X-API-KEY: dein-schlüssel-hierDie Antwort enthält die IDs des Projekts und des Connectors:
{ \n \"projectId\": \"dein-projekt-uuid\", \n \"connectorId\": \"dein-connector-uuid\" \n}Copy-paste Konfiguration (Cursor, Produktion)
Erstelle
.cursor/mcp.jsonund füge Folgendes ein:
{
"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}"
}
}
}
}Copy-paste Konfiguration (Claude Desktop, Produktion)
Öffne
~/Library/Application Support/Claude/claude_desktop_config.jsonund füge Folgendes in
mcpServersein:
{
"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>"
]
}
}MCP-Endpunkt (Core)
Orbitype stellt MCP zusätzlich auf Core bereit:
POST https://core.orbitype.com/api/mcp/v1Die Authentifizierung ist identisch zur REST-API:
X-API-KEY: dein-schlüssel-hierEin API-Schlüssel ist immer genau einem Connector zugeordnet. Discovery und Tools sind automatisch auf diesen Connector begrenzt.
MCP-Discovery und Kontext
Verwende die Standard-JSON-RPC-Methoden:
initializetools/listtools/callEmpfohlener erster Aufruf:
orbitype_get_contextDieser liefert Projekt-/Connector-Kontext, S3-Prefix (falls vorhanden) und Hinweise zur sicheren Nutzung.
Verfügbare MCP-Tools
Die Tool-Namen sind Cursor-kompatibel (alphanumerisch + Unterstriche):
SQL
sql_readonly_querysql_crud_executeS3
s3_lists3_puts3_deletes3_copys3_signed_urlKontext
orbitype_get_contextS3-Prefix-Erzwingung
Für Shared Buckets erzwingt Orbitype den Connector-Prefix serverseitig bei S3-Aufrufen.
Pfade müssen mit dem Connector-Prefix beginnen (für
path,
from,
to). Ungültige Pfade liefern einen klaren JSON-RPC-Validierungsfehler statt eines unklaren AWS-Fehlers.
Claude Desktop MCP-Setup
Einige Claude-Desktop-Versionen akzeptieren Remote-Konfigurationen mit
url + headersnicht direkt. Nutze deshalb
mcp-remotein
~/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}Cursor MCP-Setup
Erstelle oder aktualisiere
.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}Lege je nach Bedarf separate Einträge für SQL/S3/public/private Keys an.
