From f54b815e234a094bb79e0c5ae506da8cd97d1cf8 Mon Sep 17 00:00:00 2001 From: Admin Date: Tue, 18 Mar 2025 03:03:45 -0700 Subject: [PATCH] Improve README documentation with more detailed tool descriptions --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 025d8d4..1bcc076 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,14 @@ env GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token GITLAB_API_URL=your_gitlab_ap | Tool | Description | Parameters | Returns | |------|-------------|------------|---------| | **`create_or_update_file`** | Create or update a single file in a GitLab project 📝 | • `project_id` (string): Project ID or path
• `file_path` (string): Path to create/update
• `content` (string): File content
• `commit_message` (string): Commit message
• `branch` (string): Target branch
• `previous_path` (optional): Previous path when renaming | File content and commit details | -| **`push_files`** | Push multiple files in a single commit 📤 | • `project_id` (string): Project ID or path
• `branch` (string): Target branch
• `files` (array): Array of files with `file_path` and `content`
• `commit_message` (string): Commit message | Updated branch reference | +| **`push_files`** | Push multiple files in a single commit 📤 (internally creates a tree and commit) | • `project_id` (string): Project ID or path
• `branch` (string): Target branch
• `files` (array): Array of files with `file_path` and `content`
• `commit_message` (string): Commit message | Updated branch reference | | **`search_repositories`** | Search for GitLab projects 🔍 | • `search` (string): Search query
• `page` (optional): Page number (default: 1)
• `per_page` (optional): Results per page (default: 20) | Project search results | | **`create_repository`** | Create a new GitLab project ➕ | • `name` (string): Project name
• `description` (optional): Project description
• `visibility` (optional): Visibility level
• `initialize_with_readme` (optional): Initialize with README | Created project details | | **`get_file_contents`** | Get the contents of a file or directory 📂 | • `project_id` (string): Project ID or path
• `file_path` (string): Path to file/directory
• `ref` (optional): Branch, tag, or commit SHA | File/directory content | | **`create_issue`** | Create a new issue 🐛 | • `project_id` (string): Project ID or path
• `title` (string): Issue title
• `description` (string): Issue description
• `assignee_ids` (optional): Array of assignee IDs
• `milestone_id` (optional): Milestone ID
• `labels` (optional): Array of labels | Created issue details | -| **`list_issues`** | List issues in a project with filtering options | • `project_id` (string): Project ID or path
• Various optional filtering parameters | Array of issues | +| **`list_issues`** | List issues in a project with comprehensive filtering options 📋 | • `project_id` (string): Project ID or path
• Optional filters: `assignee_id`, `assignee_username`, `author_id`, `author_username`, `confidential`, `created_after/before`, `due_date`, `label_name`, `milestone`, `scope`, `search`, `state`, `updated_after/before`
• Pagination: `page`, `per_page` | Array of issues | | **`get_issue`** | Get details of a specific issue | • `project_id` (string): Project ID or path
• `issue_iid` (number): Issue IID | Issue details | -| **`update_issue`** | Update an existing issue | • `project_id` (string): Project ID or path
• `issue_iid` (number): Issue IID
• Various optional update parameters | Updated issue details | +| **`update_issue`** | Update an existing issue ✏️ | • `project_id` (string): Project ID or path
• `issue_iid` (number): Issue IID
• Editable fields: `title`, `description`, `assignee_ids`, `labels`, `milestone_id`, `state_event` (close/reopen), `confidential`, `discussion_locked`, `due_date`, `weight` | Updated issue details | | **`delete_issue`** | Delete an issue | • `project_id` (string): Project ID or path
• `issue_iid` (number): Issue IID | Success message | | **`list_issue_links`** | List all links for a specific issue | • `project_id` (string): Project ID or path
• `issue_iid` (number): Issue IID | Array of linked issues | | **`get_issue_link`** | Get details of a specific issue link | • `project_id` (string): Project ID or path
• `issue_iid` (number): Issue IID
• `issue_link_id` (number): Link ID | Issue link details | @@ -63,13 +63,13 @@ env GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token GITLAB_API_URL=your_gitlab_ap | **`create_branch`** | Create a new branch 🌿 | • `project_id` (string): Project ID or path
• `branch` (string): New branch name
• `ref` (optional): Reference to create from | Created branch reference | | **`get_merge_request`** | Get details of a merge request ℹ️ | • `project_id` (string): Project ID or path
• `merge_request_iid` (number): MR IID | Merge request details | | **`get_merge_request_diffs`** | Get changes of a merge request | • `project_id` (string): Project ID or path
• `merge_request_iid` (number): MR IID
• `view` (optional): Diff view type | Array of merge request diffs | -| **`update_merge_request`** | Update a merge request 🔄 | • `project_id` (string): Project ID or path
• `merge_request_iid` (number): MR IID
• Various optional update parameters | Updated merge request details | +| **`update_merge_request`** | Update a merge request 🔄 | • `project_id` (string): Project ID or path
• `merge_request_iid` (number): MR IID
• Editable fields: `title`, `description`, `target_branch`, `assignee_ids`, `labels`, `state_event` (close/reopen), `remove_source_branch`, `squash`, `draft` | Updated merge request details | | **`create_note`** | Create a comment on an issue or MR 💬 | • `project_id` (string): Project ID or path
• `noteable_type` (string): "issue" or "merge_request"
• `noteable_iid` (number): IID of the issue or MR
• `body` (string): Comment content | Created note details | | **`list_namespaces`** | List available namespaces | • `search` (optional): Search term
• `page` (optional): Page number
• `per_page` (optional): Results per page
• `owned` (optional): Filter by ownership | Array of namespaces | | **`get_namespace`** | Get details of a namespace | • `namespace_id` (string): Namespace ID or path | Namespace details | | **`verify_namespace`** | Check if a namespace exists | • `path` (string): Namespace path to verify | Verification result | | **`get_project`** | Get details of a specific project | • `project_id` (string): Project ID or path | Project details | -| **`list_projects`** | List accessible projects | • Various optional filtering parameters | Array of projects | +| **`list_projects`** | List accessible projects with rich filtering options 📊 | • Search/filtering: `search`, `owned`, `membership`, `archived`, `visibility`
• Features filtering: `with_issues_enabled`, `with_merge_requests_enabled`
• Sorting: `order_by`, `sort`
• Access control: `min_access_level`
• Pagination: `page`, `per_page`, `simple` | Array of projects | ## Environment Variable Configuration