Skip to main content
Glama
aliyun

AlibabaCloud DevOps MCP Server

Official
by aliyun

create_commit_comment

Add comments to specific commits in Alibaba Cloud DevOps repositories to provide feedback, document changes, or track issues directly in the code history.

Instructions

[Code Management] Create a comment on a commit

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
organizationIdYes组织ID
repositoryIdYes代码库ID或者URL-Encoder编码的全路径
shaYes提交的SHA值
contentYescommit的评论内容

Implementation Reference

  • Handler code for the 'create_commit_comment' tool: validates input parameters using the schema, calls the core implementation function, and returns the result as a formatted text content block.
    case 'create_commit_comment':
      const createCommitCommentParams = CreateCommitCommentRequestSchema.parse(request.params.arguments);
      const createCommitCommentResult = await createCommitComment(createCommitCommentParams);
      return {
        content: [{ type: "text", text: JSON.stringify(createCommitCommentResult, null, 2) }],
      };
  • Core implementation function that encodes the repository ID, constructs the API URL, and sends a POST request to create the commit comment via yunxiaoRequest utility.
    export async function createCommitComment(params: z.infer<typeof CreateCommitCommentRequestSchema>) {
      const { organizationId, repositoryId, sha, content } = params;
      
      const encodedRepoId = handleRepositoryIdEncoding(repositoryId);
    
      const url = `/oapi/v1/codeup/organizations/${organizationId}/repositories/${encodedRepoId}/commits/${sha}/comments`;
    
      const response: any = await yunxiaoRequest(url, { 
        method: "POST",
        body: { content }
      });
    
      return response;
    }
  • Zod schema defining the input parameters for the create_commit_comment tool: organizationId, repositoryId, sha, and content.
    export const CreateCommitCommentRequestSchema = z.object({
      organizationId: z.string().describe("组织ID"),
      repositoryId: z.string().describe("代码库ID或者URL-Encoder编码的全路径"),
      sha: z.string().describe("提交的SHA值"),
      content: z.string().describe("commit的评论内容"),
    });
  • Tool registration entry defining the name, description, and input schema for the 'create_commit_comment' tool.
    {
      name: 'create_commit_comment',
      description: '[Code Management] Create a comment on a commit',
      inputSchema: zodToJsonSchema(CreateCommitCommentRequestSchema),
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the action ('Create') which implies a write/mutation operation, but provides no information about permissions required, rate limits, whether the comment is editable/deletable, or what happens on success/failure. This is inadequate for a mutation tool with zero annotation coverage.

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

Conciseness5/5

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

The description is extremely concise - a single sentence with zero wasted words. The domain context is front-loaded with '[Code Management]', followed immediately by the core action and target. Every element earns its place.

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?

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't explain what the tool returns, error conditions, or behavioral constraints. While concise, it lacks the completeness needed for an agent to confidently invoke this write operation without additional 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 description coverage is 100%, so the schema already documents all four parameters. The description doesn't add any parameter-specific information beyond what's in the schema, such as format examples for 'repositoryId' or length constraints for 'content'. The baseline of 3 is appropriate when the schema does the heavy lifting.

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 ('Create a comment') and target resource ('on a commit'), with the '[Code Management]' prefix providing domain context. However, it doesn't differentiate from sibling tools like 'create_change_request_comment' or 'create_work_item_comment', which perform similar commenting functions on different resources.

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?

No guidance is provided about when to use this tool versus alternatives. The description doesn't mention prerequisites, appropriate contexts, or how this differs from other comment-creation tools in the sibling list, leaving the agent with no 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