ultralytics-mcp 0.1.0 → 0.1.2

package/README.md

@@ -1,9 +1,28 @@
 # Ultralytics Platform MCP
 
-MCP server for the Ultralytics Platform REST API.
+MCP server for the [Ultralytics Platform](https://platform.ultralytics.com).
 
-Current milestone: protocol scaffold with CLI entrypoint and protocol-level
-tests. Tooling and API features land incrementally from here.
+> Independent community project. Not affiliated with or endorsed by Ultralytics.
+
+Current milestone: read, monitor, predict, export, and initial project and
+dataset lifecycle tools are available. Additional resource-management tools
+land incrementally from here.
+
+## Tools (20)
+
+| Tool | Description |
+| --- | --- |
+| `projects_list` / `projects_get` | Browse projects |
+| `projects_create` / `projects_delete` | Create / soft-delete projects |
+| `datasets_list` / `datasets_get` / `datasets_create` / `datasets_delete` / `dataset_ingest` / `dataset_upload_file` | Browse / create / soft-delete datasets, start remote ingest jobs, and upload archive files |
+| `models_list` / `models_get` | Browse trained models and metrics |
+| `training_monitor` | Status, progress, and latest metrics |
+| `model_predict` | Run inference on an image URL or base64 source |
+| `model_download` | Download a model weight file to a local path |
+| `gpu_availability` | Cloud GPU stock status |
+| `exports_list` / `export_status` | List / check export jobs |
+| `export_create` | Create an export job — **requires `confirm_cost: true`** |
+| `training_start` | Start cloud training — **requires `confirm_cost: true`** |
 
 ## Development
 

package/dist/client.js

@@ -20,6 +20,7 @@ export class UltralyticsClient {
     maxRetries;
     fetchImpl;
     downloadFetchImpl;
+    uploadFetchImpl;
     constructor(options = {}) {
         this.baseUrl = (options.baseUrl ?? getApiBase()).replace(/\/+$/, "");
         this.apiKey = options.apiKey ?? getApiKey();
@@ -27,6 +28,7 @@ export class UltralyticsClient {
         this.maxRetries = options.maxRetries ?? 3;
         this.fetchImpl = options.fetchImpl ?? fetch;
         this.downloadFetchImpl = options.downloadFetchImpl ?? fetch;
+        this.uploadFetchImpl = options.uploadFetchImpl ?? fetch;
     }
     // -- public verbs --------------------------------------------------------
     /** GET requests are idempotent and retry 429 responses. */
@@ -63,6 +65,10 @@ export class UltralyticsClient {
             retryOn429: options.retryOn429 ?? false,
         });
     }
+    /** DELETE requests are state-changing and do not retry 429 responses. */
+    async delete(path) {
+        return this.request("DELETE", path, { retryOn429: false });
+    }
     /** Download bytes from a signed URL WITHOUT forwarding API credentials. */
     async downloadBytes(url) {
         let attempt = 0;
@@ -83,6 +89,23 @@ export class UltralyticsClient {
             throw new Error("unreachable");
         }
     }
+    /** Upload bytes to a signed URL WITHOUT forwarding API credentials. */
+    async uploadBytes(url, content, contentType) {
+        const bytes = new Uint8Array(content.byteLength);
+        bytes.set(content);
+        const response = await this.fetchWithTimeout(this.uploadFetchImpl, url, {
+            method: "PUT",
+            headers: {
+                Accept: "*/*",
+                "Content-Type": contentType,
+            },
+            body: bytes,
+        });
+        if (response.ok) {
+            return;
+        }
+        await this.handle(response, url);
+    }
     // -- internals -----------------------------------------------------------
     buildUrl(path, params) {
         const suffix = path.startsWith("/") ? path : `/${path}`;

package/dist/tools/datasets.js

@@ -1,6 +1,61 @@
 /** Read-only dataset tools. */
+import { readFile, stat } from "node:fs/promises";
+import { basename } from "node:path";
 import { resolveDataset } from "../resolve.js";
 import { asRecord, listField, pyCount, pyField } from "./shared.js";
+const DATASET_TASKS = new Set([
+    "detect",
+    "segment",
+    "semantic",
+    "classify",
+    "pose",
+    "obb",
+]);
+const TARGET_SPLITS = new Set(["train", "val", "test"]);
+const MAX_UPLOAD_BYTES = 10 * 1024 * 1024 * 1024;
+const UPLOAD_TYPES = [
+    [".tar.gz", "application/gzip"],
+    [".zip", "application/zip"],
+    [".tar", "application/x-tar"],
+    [".tgz", "application/gzip"],
+    [".ndjson", "application/x-ndjson"],
+];
+function resourceId(item, fallback) {
+    const value = item._id ?? item.id ?? item.projectId ?? item.datasetId;
+    return String(value ?? fallback ?? "None");
+}
+function validateTargetSplit(targetSplit) {
+    if (targetSplit !== undefined && !TARGET_SPLITS.has(targetSplit)) {
+        const allowed = Array.from(TARGET_SPLITS).sort().join(", ");
+        throw new Error(`Unsupported targetSplit '${targetSplit}'. Expected one of: ${allowed}.`);
+    }
+}
+async function datasetUploadFileMeta(filePath) {
+    if (!filePath.trim()) {
+        throw new Error("`filePath` is required.");
+    }
+    const info = await stat(filePath).catch(() => null);
+    if (info === null) {
+        throw new Error(`Upload file does not exist: ${filePath}`);
+    }
+    if (!info.isFile()) {
+        throw new Error(`Upload path is not a file: ${filePath}`);
+    }
+    if (info.size >= MAX_UPLOAD_BYTES) {
+        throw new Error("Upload file must be smaller than 10 GB.");
+    }
+    const filename = basename(filePath);
+    const lower = filename.toLowerCase();
+    const matched = UPLOAD_TYPES.find(([suffix]) => lower.endsWith(suffix));
+    if (!matched) {
+        throw new Error("Unsupported dataset upload file type. Expected one of: .zip, .tar, .tar.gz, .tgz, .ndjson.");
+    }
+    return {
+        filename,
+        contentType: matched[1],
+        totalBytes: info.size,
+    };
+}
 /** List datasets in the workspace, optionally filtered by username. */
 export async function datasetsList(client, username) {
     const data = await client.get("/datasets", username ? { username } : undefined);
@@ -28,3 +83,102 @@ export async function datasetsGet(client, dataset) {
         data: item,
     };
 }
+/** Create a dataset. */
+export async function datasetsCreate(client, options) {
+    if (!DATASET_TASKS.has(options.task)) {
+        const allowed = Array.from(DATASET_TASKS).sort().join(", ");
+        throw new Error(`Unsupported dataset task '${options.task}'. Expected one of: ${allowed}.`);
+    }
+    if (!options.slug.trim()) {
+        throw new Error("`slug` is required.");
+    }
+    const payload = {
+        name: options.name,
+        task: options.task,
+        slug: options.slug,
+    };
+    if (options.description !== undefined) {
+        payload.description = options.description;
+    }
+    if (options.visibility !== undefined) {
+        payload.visibility = options.visibility;
+    }
+    if (options.classNames !== undefined) {
+        payload.classNames = options.classNames;
+    }
+    const data = await client.postJson("/datasets", payload);
+    const record = asRecord(data);
+    const item = asRecord("dataset" in record ? record.dataset : data);
+    const id = resourceId(item);
+    const slug = item.slug ?? options.slug;
+    const task = item.task ?? options.task;
+    return {
+        summary: `Created dataset ${id} slug=${String(slug)} task=${String(task)}.`,
+        data: item,
+    };
+}
+/** Soft-delete a dataset by id, slug, username/slug, or dataset ul:// URI. */
+export async function datasetsDelete(client, dataset) {
+    const datasetId = await resolveDataset(client, dataset);
+    const data = await client.delete(`/datasets/${datasetId}`);
+    return {
+        summary: `Deleted dataset ${datasetId} (soft delete).`,
+        data: { id: datasetId, response: data },
+    };
+}
+/** Start a remote URL ingest job for an existing dataset. */
+export async function datasetsIngest(client, options) {
+    if (!options.sourceUrl.trim()) {
+        throw new Error("`sourceUrl` is required.");
+    }
+    validateTargetSplit(options.targetSplit);
+    const datasetId = await resolveDataset(client, options.dataset);
+    const payload = {
+        datasetId,
+        sourceUrl: options.sourceUrl,
+    };
+    if (options.targetSplit !== undefined) {
+        payload.targetSplit = options.targetSplit;
+    }
+    const data = await client.postJson("/datasets/ingest", payload);
+    const item = asRecord(data);
+    const jobId = item.jobId ?? item.id ?? "None";
+    return {
+        summary: `Started dataset ingest job ${String(jobId)} for dataset ${datasetId}.`,
+        data: item,
+    };
+}
+/** Upload a local dataset archive file, then start ingest for that upload. */
+export async function datasetUploadFile(client, options) {
+    validateTargetSplit(options.targetSplit);
+    const meta = await datasetUploadFileMeta(options.filePath);
+    const datasetId = await resolveDataset(client, options.dataset);
+    const content = await readFile(options.filePath);
+    const signed = asRecord(await client.postJson("/upload/signed-url", {
+        assetType: "datasets",
+        assetId: datasetId,
+        filename: meta.filename,
+        contentType: meta.contentType,
+        totalBytes: meta.totalBytes,
+    }));
+    const uploadUrl = String(signed.url ?? "");
+    const sessionId = String(signed.sessionId ?? "");
+    await client.uploadBytes(uploadUrl, content, meta.contentType);
+    await client.postJson("/upload/complete", { sessionId });
+    const ingestPayload = { datasetId, sessionId };
+    if (options.targetSplit !== undefined) {
+        ingestPayload.targetSplit = options.targetSplit;
+    }
+    const ingest = asRecord(await client.postJson("/datasets/ingest", ingestPayload));
+    const jobId = ingest.jobId ?? ingest.id ?? "None";
+    return {
+        summary: `Uploaded ${meta.filename} (${meta.totalBytes} bytes) and started dataset ingest job ${String(jobId)}.`,
+        data: {
+            datasetId,
+            filename: meta.filename,
+            bytes: meta.totalBytes,
+            sessionId,
+            ingest,
+        },
+    };
+}

package/dist/tools/index.js

@@ -7,28 +7,34 @@
  */
 import { z } from "zod";
 import { toMcpTextResult } from "../tool-result.js";
-import { datasetsGet, datasetsList } from "./datasets.js";
+import { datasetsCreate, datasetsDelete, datasetsGet, datasetsIngest, datasetsList, datasetUploadFile, } from "./datasets.js";
 import { modelDownload } from "./downloads.js";
 import { exportCreate, exportStatus, exportsList } from "./exports.js";
 import { gpuAvailability } from "./gpu.js";
 import { modelsGet, modelsList } from "./models.js";
 import { modelPredict } from "./predict.js";
-import { projectsGet, projectsList } from "./projects.js";
+import { projectsCreate, projectsDelete, projectsGet, projectsList, } from "./projects.js";
 import { trainingMonitor, trainingStart } from "./training.js";
-export { datasetsGet, datasetsList } from "./datasets.js";
+export { datasetsCreate, datasetsDelete, datasetsGet, datasetsIngest, datasetsList, datasetUploadFile, } from "./datasets.js";
 export { modelDownload } from "./downloads.js";
 export { exportCreate, exportStatus, exportsList } from "./exports.js";
 export { gpuAvailability } from "./gpu.js";
 export { modelsGet, modelsList } from "./models.js";
 export { modelPredict } from "./predict.js";
-export { projectsGet, projectsList } from "./projects.js";
+export { projectsCreate, projectsDelete, projectsGet, projectsList, } from "./projects.js";
 export { trainingMonitor, trainingStart } from "./training.js";
 /** Names of the read-only tools registered by `registerReadTools`. */
 export const READ_TOOL_NAMES = [
     "projects_list",
     "projects_get",
+    "projects_create",
+    "projects_delete",
     "datasets_list",
     "datasets_get",
+    "datasets_create",
+    "datasets_delete",
+    "dataset_ingest",
+    "dataset_upload_file",
     "models_list",
     "models_get",
     "gpu_availability",
@@ -43,6 +49,18 @@ export function registerReadTools(server, getClient) {
         description: "Get details for one project by id, slug, username/slug, or project ul:// URI.",
         inputSchema: { project: z.string() },
     }, async ({ project }) => toMcpTextResult(await projectsGet(getClient(), project)));
+    server.registerTool("projects_create", {
+        description: "Create a project in your Ultralytics workspace.",
+        inputSchema: {
+            name: z.string(),
+            slug: z.string().optional(),
+            description: z.string().optional(),
+        },
+    }, async ({ name, slug, description }) => toMcpTextResult(await projectsCreate(getClient(), { name, slug, description })));
+    server.registerTool("projects_delete", {
+        description: "Soft-delete a project by id, slug, username/slug, or project ul:// URI.",
+        inputSchema: { project: z.string() },
+    }, async ({ project }) => toMcpTextResult(await projectsDelete(getClient(), project)));
     server.registerTool("datasets_list", {
         description: "List datasets in your Ultralytics workspace.",
         inputSchema: { username: z.string().optional() },
@@ -51,6 +69,48 @@ export function registerReadTools(server, getClient) {
         description: "Get details for one dataset by id, slug, username/slug, or dataset ul:// URI.",
         inputSchema: { dataset: z.string() },
     }, async ({ dataset }) => toMcpTextResult(await datasetsGet(getClient(), dataset)));
+    server.registerTool("datasets_create", {
+        description: "Create a dataset in your Ultralytics workspace.",
+        inputSchema: {
+            name: z.string(),
+            task: z.string(),
+            slug: z.string(),
+            description: z.string().optional(),
+            visibility: z.string().optional(),
+            classNames: z.array(z.string()).optional(),
+        },
+    }, async ({ name, task, slug, description, visibility, classNames }) => toMcpTextResult(await datasetsCreate(getClient(), {
+        name,
+        task,
+        slug,
+        description,
+        visibility,
+        classNames,
+    })));
+    server.registerTool("datasets_delete", {
+        description: "Soft-delete a dataset by id, slug, username/slug, or dataset ul:// URI.",
+        inputSchema: { dataset: z.string() },
+    }, async ({ dataset }) => toMcpTextResult(await datasetsDelete(getClient(), dataset)));
+    server.registerTool("dataset_ingest", {
+        description: "Start a remote URL ingest job for an existing dataset.",
+        inputSchema: {
+            dataset: z.string(),
+            sourceUrl: z.string(),
+            targetSplit: z.string().optional(),
+        },
+    }, async ({ dataset, sourceUrl, targetSplit }) => toMcpTextResult(await datasetsIngest(getClient(), { dataset, sourceUrl, targetSplit })));
+    server.registerTool("dataset_upload_file", {
+        description: "Upload a local dataset archive file and start ingest for an existing dataset.",
+        inputSchema: {
+            dataset: z.string(),
+            file_path: z.string(),
+            targetSplit: z.string().optional(),
+        },
+    }, async ({ dataset, file_path, targetSplit }) => toMcpTextResult(await datasetUploadFile(getClient(), {
+        dataset,
+        filePath: file_path,
+        targetSplit,
+    })));
     server.registerTool("models_list", {
         description: "List models in a project by project id, slug, username/slug, or project ul:// URI.",
         inputSchema: { project: z.string() },

package/dist/tools/projects.js

@@ -1,6 +1,10 @@
 /** Read-only project tools. */
 import { resolveProject } from "../resolve.js";
 import { asRecord, listField, pyCount, pyField } from "./shared.js";
+function resourceId(item, fallback) {
+    const value = item._id ?? item.id ?? item.projectId ?? item.datasetId;
+    return String(value ?? fallback ?? "None");
+}
 /** List projects in the workspace, optionally filtered by username. */
 export async function projectsList(client, username) {
     const data = await client.get("/projects", username ? { username } : undefined);
@@ -27,3 +31,31 @@ export async function projectsGet(client, project) {
         data: item,
     };
 }
+/** Create a project. */
+export async function projectsCreate(client, options) {
+    const payload = { name: options.name };
+    if (options.slug !== undefined) {
+        payload.slug = options.slug;
+    }
+    if (options.description !== undefined) {
+        payload.description = options.description;
+    }
+    const data = await client.postJson("/projects", payload);
+    const record = asRecord(data);
+    const item = asRecord("project" in record ? record.project : data);
+    const id = resourceId(item);
+    const slug = item.slug ?? options.slug ?? "None";
+    return {
+        summary: `Created project ${id} slug=${String(slug)}.`,
+        data: item,
+    };
+}
+/** Soft-delete a project by id, slug, username/slug, or project ul:// URI. */
+export async function projectsDelete(client, project) {
+    const projectId = await resolveProject(client, project);
+    const data = await client.delete(`/projects/${projectId}`);
+    return {
+        summary: `Deleted project ${projectId} (soft delete).`,
+        data: { id: projectId, response: data },
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ultralytics-mcp",
-  "version": "0.1.0",
-  "description": "TypeScript MCP server for the Ultralytics Platform REST API.",
+  "version": "0.1.2",
+  "description": "MCP for Ultralytics Platform workflows, datasets, training, prediction, and model operations.",
   "type": "module",
   "bin": {
     "ultralytics-mcp": "./dist/cli.js"
@@ -20,7 +20,8 @@
     "url": "https://github.com/amanharshx/ultralytics-mcp/issues"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "engines": {
     "node": ">=20"