> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Find how an MCP server signs in

> Ask the server how its users sign in, before registering it: no
sign-in, OAuth (the MCP authorization spec), or an API key. Also
suggests a name from its host.



## OpenAPI

````yaml post /api/registry/mcp-servers/probe
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/registry/mcp-servers/probe:
    post:
      tags:
        - Registry
      summary: Find how an MCP server signs in
      description: |-
        Ask the server how its users sign in, before registering it: no
        sign-in, OAuth (the MCP authorization spec), or an API key. Also
        suggests a name from its host.
      operationId: probe_mcp_server_api_registry_mcp_servers_probe_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/McpProbeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpProbeResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    McpProbeRequest:
      properties:
        url:
          type: string
          maxLength: 2048
          title: Url
      type: object
      required:
        - url
      title: McpProbeRequest
      description: A URL to look at before registering it.
    McpProbeResponse:
      properties:
        url:
          type: string
          title: Url
        sign_in:
          type: string
          enum:
            - none
            - oauth
            - key
          title: Sign In
        issuer:
          anyOf:
            - type: string
            - type: 'null'
          title: Issuer
        needs_client:
          type: boolean
          title: Needs Client
          description: >-
            OAuth, but the sign-in server doesn't let apps register themselves:
            a client ID must be set once.
          default: false
        suggested_name:
          type: string
          title: Suggested Name
        suggested_display_name:
          type: string
          title: Suggested Display Name
      type: object
      required:
        - url
        - sign_in
        - suggested_name
        - suggested_display_name
      title: McpProbeResponse
      description: How a server signs people in, found by asking it.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.