@structured-world/gitlab-mcp 6.9.0 → 6.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -653,17 +653,17 @@ export GITLAB_PARAM_BROWSE_WORK_ITEMS_TYPES="Filter by type: ISSUE, EPIC, TASK,
653
653
  }
654
654
  ```
655
655
 
656
- ### Schema Format Configuration
656
+ ### Schema Mode Configuration
657
657
 
658
658
  Configure how CQRS tool schemas are delivered to AI clients:
659
659
 
660
660
  ```bash
661
661
  # Configure schema output format
662
- GITLAB_SCHEMA_FORMAT=flat|discriminated
662
+ GITLAB_SCHEMA_MODE=flat|discriminated
663
663
  ```
664
664
 
665
- | Format | Description | Best For |
666
- |--------|-------------|----------|
665
+ | Mode | Description | Best For |
666
+ |------|-------------|----------|
667
667
  | `flat` (default) | Merged properties with action enum | Current AI clients (Claude, GPT) |
668
668
  | `discriminated` | Full `oneOf` with action-specific branches | Advanced AI clients with native oneOf support |
669
669
 
@@ -673,7 +673,7 @@ When a tool is registered, the schema goes through a transformation pipeline:
673
673
 
674
674
  1. **Filter Denied Actions** - Removes branches for actions listed in `GITLAB_DENIED_ACTIONS`
675
675
  2. **Apply Description Overrides** - Applies `GITLAB_ACTION_*` and `GITLAB_PARAM_*` overrides
676
- 3. **Conditional Flatten** - Converts `oneOf` to flat schema when `GITLAB_SCHEMA_FORMAT=flat` (default)
676
+ 3. **Conditional Flatten** - Converts `oneOf` to flat schema when `GITLAB_SCHEMA_MODE=flat` (default)
677
677
 
678
678
  This pipeline ensures that:
679
679
  - Denied actions never appear in the schema (saves AI context tokens)
@@ -926,6 +926,26 @@ GITLAB_READONLY=true yarn list-tools # Show only read-only tools
926
926
  USE_WORKITEMS=false yarn list-tools # Hide work items tools
927
927
  ```
928
928
 
929
+ #### Generate TOOLS.md Documentation
930
+
931
+ ```bash
932
+ # Generate complete markdown documentation
933
+ yarn list-tools --export > docs/TOOLS.md
934
+
935
+ # Include table of contents
936
+ yarn list-tools --export --toc > docs/TOOLS.md
937
+
938
+ # Generate without example JSON blocks (more compact)
939
+ yarn list-tools --export --no-examples > docs/TOOLS.md
940
+ ```
941
+
942
+ The `--export` mode generates comprehensive documentation with:
943
+ - **Actions table** - Available actions extracted from CQRS schemas
944
+ - **Parameters table** - All parameters with types, required status, and action hints
945
+ - **Example JSON** - Sample request for each tool
946
+ - **Tier badges** - GitLab tier requirements
947
+ - **Version info** - Package version and generation timestamp
948
+
929
949
  #### Features
930
950
 
931
951
  - **Tier Badges** - Visual indicators for GitLab tier requirements:
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ export declare function main(): Promise<void>;