MCP
Bind each MCP server that your repository declares: the agents that may use it, its approved tools and its credential.
projectId*string1 <= lengthProject MCP view
application/json- response
projectId*stringconfigPath*stringconfigPathSource*McpConfigPathSourceWhich layer named the MCP file: the repository's ship.yml (mcp.config), the path set on the project, or the default .mcp.json. ship.yml wins.
"ship.yml""project""default"configRef*string|nullconfigStatus*string"ok""missing""invalid""unreadable"configError*string|nullwarnings*array<string>servers*array<>curl -X GET 'https://api.letsship.ai/v1/mcp/projects/string'{ "projectId": "string", "configPath": "string", "configPathSource": "ship.yml", "configRef": "string", "configStatus": "ok", "configError": "string", "warnings": [ "string" ], "servers": [ { "name": "string", "declared": { "name": "string", "transport": "http", "origin": "string", "path": "string", "command": "string", "displayArgs": [ "string" ], "headerNames": [ "string" ], "envNames": [ "string" ], "secretRefs": [ "string" ], "isolation": { "kind": "remote", "packageSpec": "string", "reason": "python" } }, "binding": { "transport": "remote", "status": "ready", "statusDetail": "string", "roles": [ "planner" ], "authKind": "none", "pinnedUrl": "string", "packageSpec": "string", "allowedEgressHosts": [ "string" ], "credentialFields": [ "string" ], "toolSnapshot": [ { "name": "string", "title": "string", "description": "string", "readOnlyHint": true, "destructiveHint": true } ], "approvedTools": [ { "name": "string", "attestedReadOnly": true } ], "toolsRefreshedAt": 0, "effectiveToolCounts": { "planner": 0, "builder": 0, "reviewer": 0, "qa": 0 }, "createdAt": 0, "updatedAt": 0 } } ]}projectId*string1 <= lengthapplication/json- body
configPath*|^[^/][^\0]*$1 <= length <= 256Updated view
application/json- response
projectId*stringconfigPath*stringconfigPathSource*McpConfigPathSourceWhich layer named the MCP file: the repository's ship.yml (mcp.config), the path set on the project, or the default .mcp.json. ship.yml wins.
"ship.yml""project""default"configRef*string|nullconfigStatus*string"ok""missing""invalid""unreadable"configError*string|nullwarnings*array<string>servers*array<>curl -X PATCH 'https://api.letsship.ai/v1/mcp/projects/string' \ -H 'Content-Type: application/json' \ -d '{ "configPath": "string"}'{ "projectId": "string", "configPath": "string", "configPathSource": "ship.yml", "configRef": "string", "configStatus": "ok", "configError": "string", "warnings": [ "string" ], "servers": [ { "name": "string", "declared": { "name": "string", "transport": "http", "origin": "string", "path": "string", "command": "string", "displayArgs": [ "string" ], "headerNames": [ "string" ], "envNames": [ "string" ], "secretRefs": [ "string" ], "isolation": { "kind": "remote", "packageSpec": "string", "reason": "python" } }, "binding": { "transport": "remote", "status": "ready", "statusDetail": "string", "roles": [ "planner" ], "authKind": "none", "pinnedUrl": "string", "packageSpec": "string", "allowedEgressHosts": [ "string" ], "credentialFields": [ "string" ], "toolSnapshot": [ { "name": "string", "title": "string", "description": "string", "readOnlyHint": true, "destructiveHint": true } ], "approvedTools": [ { "name": "string", "attestedReadOnly": true } ], "toolsRefreshedAt": 0, "effectiveToolCounts": { "planner": 0, "builder": 0, "reviewer": 0, "qa": 0 }, "createdAt": 0, "updatedAt": 0 } } ]}projectId*string1 <= lengthserverName*string^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$Deleted
application/json- response
deleted*truetruecurl -X DELETE 'https://api.letsship.ai/v1/mcp/projects/string/servers/string'{ "deleted": true}projectId*string1 <= lengthserverName*string^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$application/json- body
roles*array<>items <= 4transport?McpBindingTransportremote: the gateway proxies to the server's URL. isolate: the gateway runs the server's npm package in an isolated runtime. local: the server runs inside the agent's sandbox (no credential).
"remote""isolate""local"remoteUrl?stringurilength <= 2048credential?||approvedTools?array<>items <= 200Binding
application/json- response
transport*McpBindingTransportremote: the gateway proxies to the server's URL. isolate: the gateway runs the server's npm package in an isolated runtime. local: the server runs inside the agent's sandbox (no credential).
"remote""isolate""local"status*McpBindingStatus"ready""needs_credential""needs_reconnect""origin_changed""bundling""bundle_failed""not_isolatable"statusDetail*string|nullroles*array<>authKind*McpAuthKind"none""headers""oauth""isolate-env"pinnedUrl*string|nullpackageSpec*string|nullallowedEgressHosts*array<string>credentialFields*array<string>toolSnapshot*array<>approvedTools*array<>toolsRefreshedAt*integer|nulleffectiveToolCounts*createdAt*integerupdatedAt*integercurl -X PUT 'https://api.letsship.ai/v1/mcp/projects/string/servers/string' \ -H 'Content-Type: application/json' \ -d '{ "roles": [ "planner" ]}'{ "transport": "remote", "status": "ready", "statusDetail": "string", "roles": [ "planner" ], "authKind": "none", "pinnedUrl": "string", "packageSpec": "string", "allowedEgressHosts": [ "string" ], "credentialFields": [ "string" ], "toolSnapshot": [ { "name": "string", "title": "string", "description": "string", "readOnlyHint": true, "destructiveHint": true } ], "approvedTools": [ { "name": "string", "attestedReadOnly": true } ], "toolsRefreshedAt": 0, "effectiveToolCounts": { "planner": 0, "builder": 0, "reviewer": 0, "qa": 0 }, "createdAt": 0, "updatedAt": 0}projectId*string1 <= lengthserverName*string^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$Binding with a fresh snapshot
application/json- response
transport*McpBindingTransportremote: the gateway proxies to the server's URL. isolate: the gateway runs the server's npm package in an isolated runtime. local: the server runs inside the agent's sandbox (no credential).
"remote""isolate""local"status*McpBindingStatus"ready""needs_credential""needs_reconnect""origin_changed""bundling""bundle_failed""not_isolatable"statusDetail*string|nullroles*array<>authKind*McpAuthKind"none""headers""oauth""isolate-env"pinnedUrl*string|nullpackageSpec*string|nullallowedEgressHosts*array<string>credentialFields*array<string>toolSnapshot*array<>approvedTools*array<>toolsRefreshedAt*integer|nulleffectiveToolCounts*createdAt*integerupdatedAt*integercurl -X POST 'https://api.letsship.ai/v1/mcp/projects/string/servers/string/tools/refresh'{ "transport": "remote", "status": "ready", "statusDetail": "string", "roles": [ "planner" ], "authKind": "none", "pinnedUrl": "string", "packageSpec": "string", "allowedEgressHosts": [ "string" ], "credentialFields": [ "string" ], "toolSnapshot": [ { "name": "string", "title": "string", "description": "string", "readOnlyHint": true, "destructiveHint": true } ], "approvedTools": [ { "name": "string", "attestedReadOnly": true } ], "toolsRefreshedAt": 0, "effectiveToolCounts": { "planner": 0, "builder": 0, "reviewer": 0, "qa": 0 }, "createdAt": 0, "updatedAt": 0}Bindings
application/json- response
bindings*array<>curl -X GET 'https://api.letsship.ai/v1/mcp/bindings'{ "bindings": [ { "projectId": "string", "projectName": "string", "serverName": "string", "transport": "remote", "status": "ready", "statusDetail": "string", "roles": [ "planner" ], "authKind": "none", "credentialFields": [ "string" ], "updatedAt": 0 } ]}projectId*string1 <= lengthserverName*string^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$application/json- body
scope?stringlength <= 512returnTo?string^\/length <= 512Consent URL
application/json- response
authorizeUrl*stringexpiresAt*integercurl -X POST 'https://api.letsship.ai/v1/mcp/projects/string/servers/string/oauth/start' \ -H 'Content-Type: application/json' \ -d '{}'{ "authorizeUrl": "string", "expiresAt": 0}application/json- body
code*string1 <= length <= 2048state*string16 <= length <= 256Credential stored
application/json- response
projectId*stringserverName*stringreturnTo*string|nullcurl -X POST 'https://api.letsship.ai/v1/mcp/oauth/complete' \ -H 'Content-Type: application/json' \ -d '{ "code": "string", "state": "stringstringstri"}'{ "projectId": "string", "serverName": "string", "returnTo": "string"}How is this page?