overlane connector mcp add

Adds a server to the team’s allowlist. The URL must be https on the default port or 8443, a public DNS name (no IP literal, no local or internal name) with no credentials in it; the check runs again at every call. An optional bearer token goes to the vault (–secret-env or –secret-stdin). Allowing a server is in the policy autonomy class.

Usage

overlane connector mcp add [--service URL] [--team TENANT_ID] --name TEXT --url URL [--secret-env NAME] [--secret-stdin] [--dry-run]

Flags

Flag	Type	Required	Description
`--service`	string	no	The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no	The team (tenant) to act on (default: the one your token belongs to)
`--name`	string	yes	A name for the server
`--url`	string	yes	The server’s https URL
`--secret-env`	string	no	Environment variable that holds the server’s bearer token
`--secret-stdin`	boolean	no	Read the bearer token from standard input
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane connector mcp add --name Docs --url https://mcp.example.com/mcp
overlane connector mcp add --name Docs --url https://mcp.example.com/mcp --secret-env DOCS_MCP_TOKEN

Behavior

Effect: write (changes local or hosted state).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: no.
Machine-readable description: overlane schema connector mcp add.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "server": {
          "type": "object",
          "properties": {
            "serverId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "hasCredential": {
              "type": "boolean"
            },
            "createdAt": {
              "type": "string"
            }
          },
          "required": [
            "serverId",
            "name",
            "url",
            "hasCredential",
            "createdAt"
          ],
          "additionalProperties": false
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "server",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.