create_upstream
Configure and deploy an upstream service with load balancing, health checks, and timeout settings using customizable algorithms for efficient traffic management.
Instructions
Create an upstream service with load balancing settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | upstream id | |
| upstream | Yes | upstream service configuration object |
Implementation Reference
- src/tools/upstream.ts:6-13 (handler)Executes the create_upstream tool by calling the Admin API with POST to /upstreams if no id, or PUT to /upstreams/{id} if id provided.
server.tool("create_upstream", "Create an upstream service with load balancing settings", CreateUpstreamSchema.shape, async (args) => { const upstreamId = args.id; if (!upstreamId) { return await makeAdminAPIRequest(`/upstreams`, "POST", args.upstream); } else { return await makeAdminAPIRequest(`/upstreams/${upstreamId}`, "PUT", args.upstream); } }); - src/schemas/upstream.ts:70-70 (schema)Zod schema for validating input to the create_upstream tool, consisting of optional id and upstream configuration object.
export const CreateUpstreamSchema = z.object({ id: z.string().optional().describe("upstream id"), upstream: UpstreamSchema }); - src/tools/upstream.ts:6-13 (registration)Registers the create_upstream tool on the MCP server with description, input schema, and handler function.
server.tool("create_upstream", "Create an upstream service with load balancing settings", CreateUpstreamSchema.shape, async (args) => { const upstreamId = args.id; if (!upstreamId) { return await makeAdminAPIRequest(`/upstreams`, "POST", args.upstream); } else { return await makeAdminAPIRequest(`/upstreams/${upstreamId}`, "PUT", args.upstream); } }); - src/utils/adminAPI.ts:11-80 (helper)Helper function that performs HTTP requests to the APISIX Admin API endpoint, handling success and error responses as MCP CallToolResult. Used by the create_upstream handler.
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), }, ], }; } } }