Skip to main content
Glama
aliyun

AlibabaCloud DevOps MCP Server

Official
by aliyun

create_effort_record

Log actual work hours for project tasks in Alibaba Cloud DevOps to track time spent on specific work items with start/end dates and descriptions.

Instructions

[Project Management] 登记实际工时

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes工作项唯一标识
organizationIdYesorganizationId
actualTimeYes实际工时
descriptionNo工作描述
gmtEndYes工作开始结束日期
gmtStartYes工作开始日期
operatorIdNo操作者的useId,个人token时该参数无效
workTypeNo工作类型

Implementation Reference

  • MCP tool handler switch case for 'create_effort_record': validates input using CreateEffortRecordSchema and calls effort.createEffortRecord from operations/projex/effort.ts
    case "create_effort_record": {
      const args = types.CreateEffortRecordSchema.parse(request.params.arguments);
      const result = await effort.createEffortRecord({
        id: args.id,
        organizationId: args.organizationId,
        actualTime: args.actualTime,
        description: args.description,
        gmtEnd: args.gmtEnd,
        gmtStart: args.gmtStart,
        operatorId: args.operatorId,
        workType: args.workType
      });
      return {
        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
      };
    }
  • Registration of the 'create_effort_record' tool in getEffortTools array, specifying name, description, and input schema
    {
      name: "create_effort_record",
      description: "[Project Management] 登记实际工时",
      inputSchema: zodToJsonSchema(CreateEffortRecordSchema),
    },
  • Core helper function implementing createEffortRecord: API POST to create effort record via yunxiaoRequest, using CreateEffortRecordRequestSchema
    export async function createEffortRecord(
      params: z.infer<typeof CreateEffortRecordRequestSchema> & {
        id: string;
        organizationId: string;
      }
    ) {
      const validatedParams = CreateEffortRecordRequestSchema.parse({
        actualTime: params.actualTime,
        description: params.description,
        gmtEnd: params.gmtEnd,
        gmtStart: params.gmtStart,
        operatorId: params.operatorId,
        workType: params.workType
      });
      
      const url = `/oapi/v1/projex/organizations/${params.organizationId}/workitems/${params.id}/effortRecords`;
      
      const response = await yunxiaoRequest(url, {
        method: "POST",
        body: validatedParams
      });
    
      return IdentifierDTOSchema.parse(response);
    }
  • Input schema CreateEffortRecordSchema: Zod object used for tool argument validation in handler and registration
    export const CreateEffortRecordSchema = z.object({
      id: z.string().describe("工作项唯一标识"),
      organizationId: z.string().describe("organizationId"),
      actualTime: z.number().positive().describe("实际工时"),
      description: z.string().max(500).optional().describe("工作描述"),
      gmtEnd: z.string().describe("工作开始结束日期"),
      gmtStart: z.string().describe("工作开始日期"),
      operatorId: z.string().optional().describe("操作者的useId,个人token时该参数无效"),
      workType: z.string().optional().describe("工作类型"),
    });
  • Internal API request schema CreateEffortRecordRequestSchema: Zod object used for validating body in createEffortRecord helper
    export const CreateEffortRecordRequestSchema = z.object({
      actualTime: z.number().positive().describe("实际工时"),
      description: z.string().max(500).optional().describe("工作描述"),
      gmtEnd: z.string().describe("工作开始结束日期"),
      gmtStart: z.string().describe("工作开始日期"),
      operatorId: z.string().optional().describe("操作者的useId,个人token时该参数无效"),
      workType: z.string().optional().describe("工作类型"),
    });
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. While '登记' (register) implies a write operation, the description doesn't specify whether this creates new records (vs. updates), what permissions are required, whether it's idempotent, or what happens on success/failure. For a mutation tool with zero annotation coverage, this is a significant gap.

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?

The description is extremely concise (just two Chinese words plus a project management context label), which is efficient. However, it's arguably too brief for a tool with 8 parameters and no annotations, potentially under-specifying rather than being optimally concise.

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

Completeness2/5

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

Given this is a mutation tool (creating effort records) with 8 parameters, no annotations, and no output schema, the description is inadequate. It doesn't explain what the tool returns, error conditions, or behavioral nuances. The agent would struggle to use this effectively without trial and error.

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 description coverage is 100%, so the schema already documents all 8 parameters thoroughly. The description adds no additional parameter information beyond what's in the schema (e.g., no examples, format clarifications, or relationships between parameters). With high schema coverage, the baseline score of 3 is appropriate.

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

Purpose4/5

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

The description clearly states the action ('登记实际工时' translates to 'register actual working hours') and resource ('工时' means working hours/effort), providing a specific verb+resource combination. However, it doesn't explicitly distinguish this tool from sibling tools like 'create_estimated_effort' or 'update_effort_record', which would be needed for a score of 5.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'create_estimated_effort' (for estimated hours) or 'update_effort_record' (for modifying existing records). There's no mention of prerequisites, context, or exclusions, leaving the agent with minimal usage direction.

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/aliyun/alibabacloud-devops-mcp-server'

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