update_file
Update file content in a GitLab repository by specifying project ID, file path, new content, branch, and commit message.
Instructions
Update an existing file in repository.
Args:
project_id: GitLab project ID
file_path: Path to the file
content: New file content
branch: Target branch
commit_message: Commit message
token: GitLab Personal Access Token (optional)
ctx: MCP context (automatically injected)Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | ||
| file_path | Yes | ||
| content | Yes | ||
| branch | Yes | ||
| commit_message | Yes | ||
| token | No | ||
| ctx | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- The handler function for the 'update_file' tool. It updates an existing file in a GitLab repository by making a PUT request to the repository files API endpoint with the file path, content, branch, and commit message.
@mcp.tool() async def update_file(project_id: int, file_path: str, content: str, branch: str, commit_message: str, token: str = None, ctx=None) -> str: """Update an existing file in repository. Args: project_id: GitLab project ID file_path: Path to the file content: New file content branch: Target branch commit_message: Commit message token: GitLab Personal Access Token (optional) ctx: MCP context (automatically injected) """ import urllib.parse encoded_path = urllib.parse.quote(file_path, safe='') data = { "branch": branch, "content": content, "commit_message": commit_message } result = await make_gitlab_request(f"/projects/{project_id}/repository/files/{encoded_path}", "PUT", data, ctx=ctx, token=token) if isinstance(result, dict) and "error" in result: return f"Error updating file: {result['error']}" return f"File updated: {file_path} in branch {branch}" - gitlab_clone_mcp_server/server.py:767-768 (registration)The tool is registered via the @mcp.tool() decorator on the update_file async function, using FastMCP's automatic tool registration mechanism.
@mcp.tool() async def update_file(project_id: int, file_path: str, content: str, branch: str, commit_message: str, token: str = None, ctx=None) -> str: - Helper function used by update_file to make the actual HTTP PUT request to the GitLab API.
async def make_gitlab_request(endpoint: str, method: str = "GET", data: dict = None, ctx=None, token: str = None) -> dict[str, Any] | None: """Make a request to GitLab API with proper error handling.""" # Priority: 1. Explicit token parameter, 2. Context headers, 3. Environment variable # If no explicit token provided, try to get from context if not token and ctx and hasattr(ctx, 'request_context') and ctx.request_context: # Try to get from request headers if hasattr(ctx.request_context, 'headers'): token = ctx.request_context.headers.get('GITLAB_TOKEN') # Fallback to environment variable if not token: token = os.getenv("GITLAB_TOKEN") if not token: return {"error": "GitLab token not provided. Please provide a token parameter, GITLAB_TOKEN in the request headers, or set the environment variable."} # Get GitLab URL (from context or environment) gitlab_url = os.getenv("GITLAB_URL", "https://gitlab.com") headers = { "PRIVATE-TOKEN": token, "Content-Type": "application/json" } url = f"{gitlab_url}/api/v4{endpoint}" async with httpx.AsyncClient() as client: try: if method == "GET": response = await client.get(url, headers=headers, timeout=30.0) elif method == "POST": response = await client.post(url, headers=headers, json=data, timeout=30.0) elif method == "PUT": response = await client.put(url, headers=headers, json=data, timeout=30.0) elif method == "DELETE": response = await client.delete(url, headers=headers, timeout=30.0) response.raise_for_status() return response.json() if response.content else {"success": True} except Exception as e: return {"error": str(e)}