get-gpu-instance
Retrieve detailed information about a specific GPU instance on the Novita MCP Server using its unique instance ID. Simplify resource management and tracking.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ID of the instance to retrieve |
Implementation Reference
- src/tools.ts:121-139 (handler)The handler function for 'get-gpu-instance' tool. It constructs the API query for the instance ID, calls novitaRequest to fetch data, clears sensitive information, and returns a formatted text response with JSON.}, async (params) => { // Construct query parameters const queryParams = new URLSearchParams(); queryParams.append("instanceId", params.instanceId); const queryString = queryParams.toString() ? `?${queryParams.toString()}` : ""; const result = await novitaRequest(`/gpu/instance${queryString}`); clearSensitiveInfo(result); return { content: [ { type: "text", text: JSON.stringify(result, null, 2), }, ], }; });
- src/tools.ts:118-120 (schema)Input schema for 'get-gpu-instance' tool defining the required 'instanceId' parameter.instanceId: z .string() .describe("ID of the instance to retrieve"),
- src/tools.ts:117-139 (registration)Registration of the 'get-gpu-instance' tool on the MCP server, including schema and handler.server.tool("get-gpu-instance", { instanceId: z .string() .describe("ID of the instance to retrieve"), }, async (params) => { // Construct query parameters const queryParams = new URLSearchParams(); queryParams.append("instanceId", params.instanceId); const queryString = queryParams.toString() ? `?${queryParams.toString()}` : ""; const result = await novitaRequest(`/gpu/instance${queryString}`); clearSensitiveInfo(result); return { content: [ { type: "text", text: JSON.stringify(result, null, 2), }, ], }; });
- src/utils.ts:15-55 (helper)Helper function to make authenticated HTTP requests to the Novita AI GPU instance API.export async function novitaRequest( endpoint: string, method: string = "GET", body: any = null ) { // Base URL for Novita AI API const API_BASE_URL = "https://api.novita.ai/gpu-instance/openapi/v1"; // Get API key from environment variable const API_KEY = process.env.NOVITA_API_KEY; const url = `${API_BASE_URL}${endpoint}`; const headers = { Authorization: `Bearer ${API_KEY}`, "Content-Type": "application/json", }; const options: any = { method, headers, }; if (body && (method === "POST" || method === "PATCH")) { options.body = JSON.stringify(body); } try { const response = await fetch(url, options); if (!response.ok) { const errorText = await response.text(); throw new Error(`Novita AI API Error: ${response.status} - ${errorText}`); } // Some endpoints might not return JSON const contentType = response.headers.get("content-type"); if (contentType && contentType.includes("application/json")) { return await response.json(); } return { success: true, status: response.status }; } catch (error) { console.error("Error calling Novita AI API:", error); throw error; } }
- src/utils.ts:5-12 (helper)Helper function to remove sensitive information (like sshPassword) from the API response data.export function clearSensitiveInfo(data: any) { if (data && data.instances) { data.instances = data.instances.map((instance: any) => ({ ...instance, sshPassword: undefined })); } }