> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Test a connector and list its tools
> Asks an MCP server for its tool list with the values in the connector editor, saved or
not. It is the same discovery a conversation runs (https only, private and local
addresses refused, redirects refused, about half a minute at most), asked for a live
answer. Same right as saving a connector: an admin holding `institutions.edit` on the
connector's Digital Twin.
**Authorization header:** a non-empty string is used as typed; `null` means none; an
empty or absent value means the stored one (the editor never holds it). The stored value
is only ever sent to the stored origin: when `server_url` names another scheme, host or
port and no header is typed, the answer is 400.
A completed test always answers 200; `ok` says whether the server answered.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/mcpserver/test
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.199
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/mcpserver/test:
post:
tags:
- Admin MCP Servers
summary: Test a connector and list its tools
description: >
Asks an MCP server for its tool list with the values in the connector
editor, saved or
not. It is the same discovery a conversation runs (https only, private
and local
addresses refused, redirects refused, about half a minute at most),
asked for a live
answer. Same right as saving a connector: an admin holding
`institutions.edit` on the
connector's Digital Twin.
**Authorization header:** a non-empty string is used as typed; `null`
means none; an
empty or absent value means the stored one (the editor never holds it).
The stored value
is only ever sent to the stored origin: when `server_url` names another
scheme, host or
port and no header is typed, the answer is 400.
A completed test always answers 200; `ok` says whether the server
answered.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: >-
The saved connector being edited. Omit for a connector that
is being added.
institution:
type: string
description: >-
The Digital Twin, required when `id` is omitted. Ignored for
a saved connector (its own twin is used).
name:
type: string
description: >-
The connector label; the identity headers are signed for it.
Required when `id` is omitted.
server_url:
type: string
example: https://docs.praxis-ai.com/mcp
authorization_header:
type: string
nullable: true
example: Bearer XXXX
responses:
'200':
description: The test ran
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
ok:
type: boolean
description: Whether the server answered with its tool list
count:
type: integer
example: 2
truncated:
type: boolean
description: The server offers more tools than are listed here
tools:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
error:
type: string
nullable: true
description: Why the test failed, in words an administrator can act on
example: 'HTTP 401: Unauthorized'
ms:
type: integer
'400':
description: >-
A field is missing or malformed, or the server address changed and
the authorization header must be entered again.
'401':
description: Not signed in
'403':
description: The caller may not edit this Digital Twin
'404':
description: MCP server not found
'429':
description: A test by the same caller is still running.
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.