apps.discoverApp

POST

/v1/apps/discover

const url = 'https://example.com/v1/apps/discover';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"input":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Finds Apps at a domain or HTTPS link. Returns OpenBot App Protocol candidates, configuration requirements and provenance (where each candidate came from). It does not add a connection, authorize an account or index a service.

Authorizations

token
session

Request Body^required

application/json

object

input

required

string

>= 1 characters

Example ^generated

{
  "input": "example"
}

Responses

200

Success

application/json

Any of:

object
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
null

string

>= 1 characters <= 100 characters

websiteUrl

Any of:

string
null

string

repository

Any of:

object
null

object

url

required

string

source

required

string

subfolder

Any of:

string
null

string

Any of:

string
null

string

icons

Any of:

Array<object>
null

Array<object>

object

src

required

string

mimeType

Any of:

string
null

string

sizes

Any of:

Array<string>
null

Array<string>

theme

Any of:

string
null

string

Allowed values: light dark

remotes

Any of:

Array<object>
null

Array<object>

object

type

required

string

Allowed values: streamable-http sse

url

required

string

headers

Any of:

Array<object>
null

Array<object>

object

description

Any of:

string
null

string

isRequired

Any of:

boolean
null

boolean

isSecret

Any of:

boolean
null

boolean

format

Any of:

string
null

string

Allowed values: string number boolean filepath

default

Any of:

string
null

string

placeholder

Any of:

string
null

string

value

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

name

required

string

variables

Any of:

object
null

object

key

additional properties

object

description

Any of:

string
null

string

isRequired

Any of:

boolean
null

boolean

isSecret

Any of:

boolean
null

boolean

format

Any of:

string
null

string

Allowed values: string number boolean filepath

default

Any of:

string
null

string

placeholder

Any of:

string
null

string

value

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

variables

Any of:

object
null

object

key

additional properties

object

description

Any of:

string
null

string

isRequired

Any of:

boolean
null

boolean

isSecret

Any of:

boolean
null

boolean

format

Any of:

string
null

string

Allowed values: string number boolean filepath

default

Any of:

string
null

string

placeholder

Any of:

string
null

string

value

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

supportedProtocolVersions

Any of:

Array<string>
null

Array<string>

_meta

Any of:

object
null

object

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>
null

Array<object>

object

description

Any of:

string
null

string

isRequired

Any of:

boolean
null

boolean

isSecret

Any of:

boolean
null

boolean

format

Any of:

string
null

string

Allowed values: string number boolean filepath

default

Any of:

string
null

string

placeholder

Any of:

string
null

string

value

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

name

required

string

variables

Any of:

object
null

object

key

additional properties

object

description

Any of:

string
null

string

isRequired

Any of:

boolean
null

boolean

isSecret

Any of:

boolean
null

boolean

format

Any of:

string
null

string

Allowed values: string number boolean filepath

default

Any of:

string
null

string

placeholder

Any of:

string
null

string

value

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

variables

Any of:

object
null

object

key

additional properties

object

description

Any of:

string
null

string

isRequired

Any of:

boolean
null

boolean

isSecret

Any of:

boolean
null

boolean

format

Any of:

string
null

string

Allowed values: string number boolean filepath

default

Any of:

string
null

string

placeholder

Any of:

string
null

string

value

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

supportedProtocolVersions

Any of:

Array<string>
null

Array<string>

requirements

required

Array<object>

object

key

required

string

description

Any of:

string
null

string

isSecret

required

boolean

format

Any of:

string
null

string

choices

Any of:

Array<string>
null

Array<string>

sources

required

Array<object>

object

role

required

string

Allowed values: input page catalog card endpoint manual

url

required

string

originalInput

Any of:

string
null

string

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

Example

{
  "_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

BadRequest | OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

422

AppDiscoveryFailed

application/json

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

Example

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

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}

apps.discoverApp

Authorizations

Request Bodyrequired

Example generated

Responses

200

Example

400

Example

401

Example

403

Example

409

Example

422

Example

429

Example

503

Example

Request Body^required

Example ^generated