xiaoZhiMcp

# MCP Management and Usage Document <br /> # xiaoZhiMcp xiaoZhiMcp connects to AI generation ## 1. Document Purpose This document is intended to guide you in using the MCP management page in the current project to complete the following operations: - Add new external MCP connections and save them to the database - Test connection connectivity - Load tool lists and execute tool calls - Delete invalid external MCP connections Page entry: `/mcp-admin.html` *** ## 2. Page Structure Description The page is divided into three areas: 1. **Add Connection** - Configure and save external MCP connections 1. **Database Connection List** - View saved connections - Perform "Test" or "Delete" on a single connection 1. **Tool Call Test (Real Execution)** - Select target (LOCAL or SAVED) - Load tools - Fill in dynamic parameters and call - View call result JSON *** ## 3. Quick Start ### Step 1: Add External Connection In "Add Connection", fill in: - Connection name (unique) - Enabled - Transmission protocol (`SSE` or `STREAMABLE`) - URL (required) - Endpoint (optional) - Headers (JSON, optional) Click: - `Test Connectivity`: Test only, no save - `Save to Database`: Save and automatically refresh running MCP clients ### Step 2: View/Manage Connections In "Database Connection List", you can: - `Test`: Test if the connection is available - `Delete`: Delete the connection and automatically refresh running MCP clients ### Step 3: Call Tools In "Tool Call Test (Real Execution)": 1. Select target type: - `LOCAL`: Call local MCP - `SAVED`: Call saved connections in the database 1. If `SAVED`, select "Connection ID" dropdown box 2. Click `Load Tool List` 3. Select tool in "Tool Name" dropdown box 4. Fill in parameters according to dynamically generated parameter input area 5. Click `Call Tool` 6. View call result JSON *** ## 4. Parameter Filling Rules Tool parameters are dynamically generated by the system according to tool schema, with the following rules: - Field names are prioritized to display English descriptions: `Description (Parameter Name)` - Example: `Record Content (message)` - Required fields are marked `(Required)` - Parameter types correspond to input controls: - `string` -> Text box - `number` / `integer` -> Number box - `boolean` -> Dropdown box (`true` / `false`) - `array` / `object` -> JSON text box - If a tool has no parameters, the page prompts "Current tool has no parameters, will automatically submit {}" *** ## 5. Frequently Asked Questions ### Q1: Why can't I see external connection tools in LOCAL mode? This is expected behavior. `LOCAL` mode only shows local tools, not mixed with external MCP tools. ### Q2: What if it prompts "Connection name already exists"? Connection names must be unique, please change to a new connection name before saving. ### Q3: What if it prompts URL cannot be empty? URL is a required field, please check the URL input in "Add Connection". ### Q4: How to troubleshoot call failures? First, check: - If the connection is connectable (click "Test Connectivity" first) - If the target type and connection ID are selected correctly - If required parameters are filled - If JSON parameter format is correct (array/object parameters) *** ## 6. Recommended Usage Process 1. Test connectivity after adding a new connection 2. Save the connection 3. Switch to SAVED in the tool call area and select the connection 4. Load tools, select the target tool 5. Fill in parameters and call 6. View "Call Result JSON" to confirm the result <br /> <br /> <br /> Frontend address <http://127.0.0.1:9998/mcp-admin.html> xiaoZhiMcp connects to AI generation.