create_service
Define and configure services on the APISIX-MCP server by specifying ID, name, labels, upstream settings, and plugins for efficient API management.
Instructions
Create a service
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | service id | |
| service | Yes | service configuration object |
Implementation Reference
- src/tools/service.ts:6-13 (handler)The implementation of the create_service tool handler. It checks if an ID is provided; if not, it creates a new service via POST to /services, otherwise updates via PUT to /services/{id}. Uses makeAdminAPIRequest helper.
server.tool("create_service", "Create a service", CreateServiceSchema.shape, async (args) => { const serviceId = args.id; if (!serviceId) { return await makeAdminAPIRequest(`/services`, "POST", args.service); } else { return await makeAdminAPIRequest(`/services/${serviceId}`, "PUT", args.service); } }); - src/utils/adminAPI.ts:11-80 (helper)Supporting utility function that executes HTTP requests to the APISIX Admin API, formats success/error responses as MCP CallToolResult.
export async function makeAdminAPIRequest( path: string, method: string = "GET", data?: object ): Promise<CallToolResult> { const baseUrl = `${APISIX_SERVER_HOST}:${APISIX_ADMIN_API_PORT}${APISIX_ADMIN_API_PREFIX}`; const url = `${baseUrl}${path}`; try { const response = await axios({ method, url, data, headers: { "X-API-KEY": APISIX_ADMIN_KEY, "Content-Type": "application/json", }, }); return { content: [ { type: "text", text: JSON.stringify(response.data, null, 2), }, ], }; } catch (error) { if (axios.isAxiosError(error)) { console.error(`Request failed: ${method} ${url}`); console.error( `Status: ${error.response?.status}, Error: ${error.message}` ); if (error.response?.data) { try { const stringifiedData = JSON.stringify(error.response.data); console.error(`Response data: ${stringifiedData}`); } catch { console.error(`Response data: [Cannot parse as JSON]`); } } return { isError: true, content: [ { type: "text", text: JSON.stringify( `Status: ${error.response?.status}\nMessage: ${error.message} Data:\n${JSON.stringify(error.response?.data || {}, null, 2)}`, null, 2 ), }, ], }; } else { return { isError: true, content: [ { type: "text", text: JSON.stringify(error, null, 2), }, ], }; } } }