gitlab_create_commit
Create atomic commits in GitLab with multiple file operations (create, update, delete, move) via API. Ideal for batch changes, ensuring all updates succeed or none apply. Supports up to 100 operations per commit, with optional author overrides for automated workflows.
Instructions
Create commit with file changes Returns: New commit details Use when: Making changes via API Supports: Multiple file operations in one commit
Key features:
Atomic: All changes or none
Multiple files: Up to 100 operations
All operations: create, update, delete, move
Example: Add feature with test { "branch": "feature/new-feature", "commit_message": "Add new feature with tests", "actions": [ {"action": "create", "file_path": "src/feature.py", "content": "..."}, {"action": "create", "file_path": "tests/test_feature.py", "content": "..."} ] }
Related tools:
gitlab_safe_preview_commit: Preview first
gitlab_list_repository_tree: Check existing files
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| actions | Yes | File operations for commit Type: array of objects Required: Yes Max items: 100 per commit Structure: { "action": "create" | "update" | "delete" | "move", "file_path": "string (required)", "content": "string (required for create/update)", "encoding": "text" | "base64" (optional, default: text)", "previous_path": "string (required for move)" } Examples: [ { "action": "create", "file_path": "src/config.json", "content": "{"debug": true}" }, { "action": "update", "file_path": "README.md", "content": "# Updated README\n\nNew content here" }, { "action": "delete", "file_path": "old-file.txt" }, { "action": "move", "file_path": "new-location/file.txt", "previous_path": "old-location/file.txt" } ] Use cases: - create: Add new files - update: Modify existing files - delete: Remove files - move: Rename or relocate files | |
| author_email | No | Commit author email Type: string Format: Valid email address Optional: Yes (uses authenticated user's email) Examples: - 'john.doe@example.com' - 'bot@automated-system.com' Use case: Override for automated commits | |
| author_name | No | Commit author name Type: string Format: Any string Optional: Yes (uses authenticated user's name) Examples: - 'John Doe' - 'Automated Bot' - 'CI System' Use case: Override for automated commits | |
| branch | Yes | Target branch for commits Type: string Required: Yes Format: Existing branch name Examples: - 'main' (commit to main) - 'feature/add-login' (feature branch) - 'hotfix/security-patch' (hotfix branch) Note: Branch must exist before committing | |
| commit_message | Yes | Commit message Type: string Required: Yes Format: Conventional commits recommended Structure: - First line: Summary (50-72 chars) - Blank line - Body: Detailed description - Footer: References, breaking changes Examples: 'feat: Add user authentication Implement JWT-based authentication with refresh tokens. Store tokens securely in httpOnly cookies. Closes #123' | |
| project_id | No | Project identifier (auto-detected if not provided) Type: integer OR string Format: numeric ID or 'namespace/project' Optional: Yes - auto-detects from current git repository Examples: - 12345 (numeric ID) - 'gitlab-org/gitlab' (namespace/project path) - 'my-group/my-subgroup/my-project' (nested groups) Note: If in a git repo with GitLab remote, this can be omitted |
Implementation Reference
- src/mcp_gitlab/tool_handlers.py:374-385 (handler)Main handler function executing the tool logic: extracts parameters and calls GitLabClient.create_commit()def handle_create_commit(client: GitLabClient, arguments: Optional[Dict[str, Any]]) -> Dict[str, Any]: """Handle creating a commit with multiple file changes""" project_id = require_project_id(client, arguments) branch = require_argument(arguments, "branch") commit_message = require_argument(arguments, "commit_message") actions = require_argument(arguments, "actions") author_email = get_argument(arguments, "author_email") author_name = get_argument(arguments, "author_name") return client.create_commit(project_id, branch, commit_message, actions, author_email, author_name)
- src/mcp_gitlab/tool_handlers.py:1051-1051 (registration)Mapping of tool name to its handler function in TOOL_HANDLERS dictionaryTOOL_CREATE_COMMIT: handle_create_commit,
- src/mcp_gitlab/tool_definitions.py:521-550 (registration)Tool registration in TOOLS list with name, description, and input schema definitiontypes.Tool( name=TOOL_CREATE_COMMIT, description=desc.DESC_CREATE_COMMIT, inputSchema={ "type": "object", "properties": { "project_id": {"type": "string", "description": desc.DESC_PROJECT_ID}, "branch": {"type": "string", "description": desc.DESC_BRANCH}, "commit_message": {"type": "string", "description": desc.DESC_COMMIT_MESSAGE}, "actions": { "type": "array", "description": desc.DESC_ACTIONS, "items": { "type": "object", "properties": { "action": {"type": "string", "enum": ["create", "update", "delete", "move"]}, "file_path": {"type": "string"}, "content": {"type": "string"}, "previous_path": {"type": "string"}, "encoding": {"type": "string", "enum": ["text", "base64"], "default": "text"} }, "required": ["action", "file_path"] } }, "author_email": {"type": "string", "description": desc.DESC_AUTHOR_EMAIL}, "author_name": {"type": "string", "description": desc.DESC_AUTHOR_NAME} }, "required": ["branch", "commit_message", "actions"] } ),
- src/mcp_gitlab/constants.py:238-238 (helper)Constant definition for the tool name used throughout the codebaseTOOL_CREATE_COMMIT = "gitlab_create_commit"