connections.prepareConnection

POST

/v1/connection-drafts

curl --request POST \
  --url https://example.com/v1/connection-drafts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "input": "example" }'

Authorizations

• token
• session

Request Body^required

Media typeapplication/json

object

input

required

string

>= 1 characters

Example ^generated

{
  "input": "example"
}

Responses

201

Success

Media typeapplication/json

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$/

revision

required

integer

<= 9007199254740991

input

required

string

>= 1 characters

expiresAt

required

number

imported

object

name

required

string

<= 80 characters

remoteIndex

required

integer

<= 9007199254740991

discovery

required

Any of:

object

object

_tag

required

string

Allowed values: Single

candidate

required

object

cardUrl

required

string

card

required

object

$schema

required

string

Allowed values: https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json

name

required

string

>= 2 characters <= 200 characters

version

required

string

>= 1 characters <= 255 characters

description

required

string

>= 1 characters <= 100 characters

title

Any of:

string

string

>= 1 characters <= 100 characters

null

null

websiteUrl

Any of:

string

string

null

null

repository

Any of:

object

object

url

required

string

source

required

string

subfolder

Any of:

string

string

null

null

id

Any of:

string

string

null

null

null

null

icons

Any of:

Array<object>

Array<object>

object

src

required

string

mimeType

Any of:

string

string

null

null

sizes

Any of:

Array<string>

Array<string>

null

null

theme

Any of:

string

string

Allowed values: light dark

null

null

null

null

remotes

Any of:

Array<object>

Array<object>

object

type

required

string

Allowed values: streamable-http sse

url

required

string

headers

Any of:

Array<object>

Array<object>

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

name

required

string

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

null

null

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

supportedProtocolVersions

Any of:

Array<string>

Array<string>

null

null

null

null

_meta

Any of:

object

object

null

null

endpoints

required

Array<object>

object

index

required

integer

<= 9007199254740991

remote

required

object

type

required

string

Allowed values: streamable-http sse

url

required

string

headers

Any of:

Array<object>

Array<object>

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

name

required

string

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

null

null

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

supportedProtocolVersions

Any of:

Array<string>

Array<string>

null

null

requirements

required

Array<object>

object

key

required

string

description

Any of:

string

string

null

null

isSecret

required

boolean

format

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

sources

required

Array<object>

object

role

required

string

Allowed values: input page catalog card endpoint manual

url

required

string

originalInput

Any of:

string

string

null

null

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

object

object

_tag

required

string

Allowed values: Multiple

candidates

required

Array<object>

>= 2 items

object

cardUrl

required

string

card

required

object

$schema

required

string

Allowed values: https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json

name

required

string

>= 2 characters <= 200 characters

version

required

string

>= 1 characters <= 255 characters

description

required

string

>= 1 characters <= 100 characters

title

Any of:

string

string

>= 1 characters <= 100 characters

null

null

websiteUrl

Any of:

string

string

null

null

repository

Any of:

object

object

url

required

string

source

required

string

subfolder

Any of:

string

string

null

null

id

Any of:

string

string

null

null

null

null

icons

Any of:

Array<object>

Array<object>

object

src

required

string

mimeType

Any of:

string

string

null

null

sizes

Any of:

Array<string>

Array<string>

null

null

theme

Any of:

string

string

Allowed values: light dark

null

null

null

null

remotes

Any of:

Array<object>

Array<object>

object

type

required

string

Allowed values: streamable-http sse

url

required

string

headers

Any of:

Array<object>

Array<object>

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

name

required

string

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

null

null

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

supportedProtocolVersions

Any of:

Array<string>

Array<string>

null

null

null

null

_meta

Any of:

object

object

null

null

endpoints

required

Array<object>

object

index

required

integer

<= 9007199254740991

remote

required

object

type

required

string

Allowed values: streamable-http sse

url

required

string

headers

Any of:

Array<object>

Array<object>

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

name

required

string

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

null

null

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

supportedProtocolVersions

Any of:

Array<string>

Array<string>

null

null

requirements

required

Array<object>

object

key

required

string

description

Any of:

string

string

null

null

isSecret

required

boolean

format

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

sources

required

Array<object>

object

role

required

string

Allowed values: input page catalog card endpoint manual

url

required

string

originalInput

Any of:

string

string

null

null

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

Example

{
  "discovery": {
    "_tag": "Single",
    "candidate": {
      "card": {
        "$schema": "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json",
        "icons": [
          {
            "theme": "light"
          }
        ],
        "remotes": [
          {
            "type": "streamable-http",
            "headers": [
              {
                "format": "string",
                "variables": {
                  "additionalProperty": {
                    "format": "string"
                  }
                }
              }
            ],
            "variables": {
              "additionalProperty": {
                "format": "string"
              }
            }
          }
        ]
      },
      "endpoints": [
        {
          "remote": {
            "type": "streamable-http",
            "headers": [
              {
                "format": "string",
                "variables": {
                  "additionalProperty": {
                    "format": "string"
                  }
                }
              }
            ],
            "variables": {
              "additionalProperty": {
                "format": "string"
              }
            }
          }
        }
      ],
      "sources": [
        {
          "role": "input"
        }
      ]
    }
  }
}

400

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "AppRestricted"
}

404

ExperienceNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: ExperienceNotFound

id

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ConnectionCleanupPending

connectionId

required

string

>= 1 characters <= 128 characters

stage

required

string

Allowed values: Credentials Connection

message

required

string

object

object

_tag

required

string

Allowed values: ConnectionConflict

reason

required

string

Allowed values: CandidateChanged RevisionChanged DraftExpired AlreadyAdded LimitReached

message

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ConnectionCleanupPending",
  "stage": "Credentials"
}

422

AppDiscoveryFailed | ConnectionConfigurationInvalid

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppDiscoveryFailed

reason

required

string

Allowed values: InvalidInput IncompatibleCard NoDeclaration NoUsableServices Document Http BlockedTarget Transport TooLarge Timeout Redirect Encoding

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

object

object

_tag

required

string

Allowed values: ConnectionConfigurationInvalid

message

required

string

keys

required

Array<string>

Example

{
  "_tag": "AppDiscoveryFailed",
  "reason": "InvalidInput"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExperienceStorageUnavailable"
}