Skip to main content
Glama
lumiclip

mcp-lumiclip

Official

get_project_status

Read-onlyIdempotent

Retrieve project status and clips for a video clipping project. Poll every 10-15 seconds until status is 'completed' to get download URLs.

Instructions

Returns a JSON object with id, name, status (pending/processing/completed/completed_no_clips/failed), step, error, expected_clips, duration, created_at, and a clips array. Clips are sorted by score (highest first). Each clip has: id, title, duration, score, reason, clip_status (pending/exporting/completed/failed), download_url (string or null), quality, thumbnail_url, created_at, updated_at. The download_url is only available when clip_status is 'completed'. Poll every 10-15 seconds until project status is 'completed'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesThe project ID returned by generate_clips

Implementation Reference

  • The handler function for the 'get_project_status' tool. It calls the API endpoint GET /api/v1/projects/{project_id} and returns the project status as a JSON string. Registered via server.tool() in the same file.
    server.tool(
      "get_project_status",
      "Returns a JSON object with id, name, status (pending/processing/completed/completed_no_clips/failed), step, error, expected_clips, duration, created_at, and a clips array. Clips are sorted by score (highest first). Each clip has: id, title, duration, score, reason, clip_status (pending/exporting/completed/failed), download_url (string or null), quality, thumbnail_url, created_at, updated_at. The download_url is only available when clip_status is 'completed'. Poll every 10-15 seconds until project status is 'completed'.",
      {
        project_id: z
          .string()
          .describe("The project ID returned by generate_clips"),
      },
      {
        title: "Get Project Status",
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: true,
        openWorldHint: true,
      },
      async ({ project_id }) => {
        try {
          const project = await apiCall(config, "GET", `/projects/${project_id}`);
          return {
            content: [
              {
                type: "text" as const,
                text: JSON.stringify(project, null, 2),
              },
            ],
          };
        } catch (err: unknown) {
          const message = err instanceof Error ? err.message : String(err);
          return {
            content: [{ type: "text" as const, text: `Error: ${message}` }],
            isError: true,
          };
        }
      }
    );
  • Input schema for get_project_status: requires a single 'project_id' string parameter defined using Zod.
    {
      project_id: z
        .string()
        .describe("The project ID returned by generate_clips"),
    },
  • src/server.ts:115-149 (registration)
    Tool registration via server.tool('get_project_status', ...) on the McpServer instance.
    server.tool(
      "get_project_status",
      "Returns a JSON object with id, name, status (pending/processing/completed/completed_no_clips/failed), step, error, expected_clips, duration, created_at, and a clips array. Clips are sorted by score (highest first). Each clip has: id, title, duration, score, reason, clip_status (pending/exporting/completed/failed), download_url (string or null), quality, thumbnail_url, created_at, updated_at. The download_url is only available when clip_status is 'completed'. Poll every 10-15 seconds until project status is 'completed'.",
      {
        project_id: z
          .string()
          .describe("The project ID returned by generate_clips"),
      },
      {
        title: "Get Project Status",
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: true,
        openWorldHint: true,
      },
      async ({ project_id }) => {
        try {
          const project = await apiCall(config, "GET", `/projects/${project_id}`);
          return {
            content: [
              {
                type: "text" as const,
                text: JSON.stringify(project, null, 2),
              },
            ],
          };
        } catch (err: unknown) {
          const message = err instanceof Error ? err.message : String(err);
          return {
            content: [{ type: "text" as const, text: `Error: ${message}` }],
            isError: true,
          };
        }
      }
    );
  • Public-facing tool schema definition for get_project_status in the server card JSON, describing input (project_id string) and output.
    {
      name: "get_project_status",
      description: "Returns {id, name, status, step, error, expected_clips, duration, clips[]}. Clips sorted by score, each with clip_status (pending/exporting/completed/failed) and download_url when ready.",
      inputSchema: {
        type: "object",
        properties: { project_id: { type: "string", description: "The project ID returned by generate_clips." } },
        required: ["project_id"],
      },
    },
  • src/http.ts:41-49 (registration)
    Registration in the MCP server card manifest at /.well-known/mcp/server-card.json listing get_project_status as an available tool.
    {
      name: "get_project_status",
      description: "Returns {id, name, status, step, error, expected_clips, duration, clips[]}. Clips sorted by score, each with clip_status (pending/exporting/completed/failed) and download_url when ready.",
      inputSchema: {
        type: "object",
        properties: { project_id: { type: "string", description: "The project ID returned by generate_clips." } },
        required: ["project_id"],
      },
    },
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. Description adds that download_url is only available when clip_status is 'completed' and clips sorted by score, which provides useful behavioral context beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Description is detailed but each sentence contributes value: return structure, sorting, clip fields, download_url condition, polling advice. Could be slightly condensed but not wasteful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite no output schema, the description provides a comprehensive breakdown of the return object, including nested clip fields and conditional availability. Polling guidance further completes the usage context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with project_id description. Description does not add additional parameter-level meaning beyond what schema provides, but it details the return structure. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool returns a JSON object with project status and clips, distinguishing it from siblings like get_clip (single clip) and generate_clips (creation). Specific verb 'Returns' and resource 'project status'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit guidance: 'Poll every 10-15 seconds until project status is completed'. This is clear context for when to call repeatedly. No explicit when-not-to-use or alternatives, but the polling advice is very helpful.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lumiclip/lumiclip-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server