docs: Prompt Library and advanced site features (Phase 2)#143
Merged
Conversation
…125) - Prompt Library with 16 pages of ready-to-use prompts organized by workflow (quick-start, code-review, CI/CD, project-management) and by role (developer, devops, team-lead, PM) - 4 step-by-step guides: code review, CI notifications, multi-GitLab setup, team onboarding - llms.txt for machine-readable documentation summary - Tool pages reorganized by use-case: code-review, ci-cd, project-management, repository - VitePress nav/sidebar updated with Prompts and Guides sections - Homepage updated with Prompt Library action button
- Add 5th guide: automate-releases.md (end-to-end release workflow) - Add tool comparison table by role (Developer/DevOps/Lead/PM) - Add Query vs Command comparison table for CQRS tools - Update sidebar and guides index with new guide
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Adds a Phase 2 documentation expansion for the VitePress site, introducing a Prompt Library, step-by-step guides, and reorganized tool documentation for workflow-based navigation.
Changes:
- Add Prompt Library pages (quick-start, code review, CI/CD, project management, and role-based collections)
- Add step-by-step guides for key workflows (code review, CI notifications, multi-instance setup, team onboarding)
- Reorganize tool docs by use-case, update VitePress nav/sidebar, and add
llms.txtfor machine-readable docs
Reviewed changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/.vitepress/config.mts | Updates nav/sidebar to add Prompts/Guides and tools-by-use-case structure |
| docs/index.md | Updates homepage CTAs to include Prompt Library |
| docs/public/llms.txt | Adds machine-readable tool/docs summary at site root |
| docs/tools/index.md | Adds “Tools by Use-Case” navigation links |
| docs/tools/code-review.md | Adds workflow-oriented code review tool documentation + examples |
| docs/tools/ci-cd.md | Adds workflow-oriented CI/CD tool documentation + examples |
| docs/tools/project-management.md | Adds workflow-oriented project management tool documentation + examples |
| docs/tools/repository.md | Adds workflow-oriented repository tool documentation + examples |
| docs/guides/index.md | Adds guides index page and cross-links |
| docs/guides/complete-code-review.md | Adds end-to-end MR review guide |
| docs/guides/setup-ci-notifications.md | Adds CI notifications setup guide |
| docs/guides/multi-gitlab-setup.md | Adds multi-instance/preset/context guide |
| docs/guides/team-onboarding.md | Adds onboarding guide for teams |
| docs/prompts/index.md | Adds Prompt Library overview and navigation |
| docs/prompts/quick-start/first-steps.md | Adds first-time usage prompt set |
| docs/prompts/quick-start/explore-repo.md | Adds repository exploration prompts |
| docs/prompts/quick-start/check-status.md | Adds prompts for MRs/pipelines/health checks |
| docs/prompts/code-review/review-mr.md | Adds review workflow prompts |
| docs/prompts/code-review/suggest-changes.md | Adds prompts for suggestions + applying them |
| docs/prompts/code-review/apply-feedback.md | Adds prompts for addressing review feedback |
| docs/prompts/ci-cd/debug-failure.md | Adds CI failure debugging prompts |
| docs/prompts/ci-cd/check-status.md | Adds pipeline monitoring prompts |
| docs/prompts/ci-cd/trigger-deploy.md | Adds deployment triggering/monitoring prompts |
| docs/prompts/project-management/sprint-planning.md | Adds sprint/milestone planning prompts |
| docs/prompts/project-management/issue-triage.md | Adds issue triage prompts |
| docs/prompts/project-management/release-notes.md | Adds release notes/release management prompts |
| docs/prompts/by-role/developer.md | Adds developer-focused prompt collection |
| docs/prompts/by-role/devops.md | Adds DevOps-focused prompt collection |
| docs/prompts/by-role/team-lead.md | Adds team lead prompt collection |
| docs/prompts/by-role/pm.md | Adds PM-focused prompt collection |
- Rename list_webhooks/list_integrations to browse_webhooks/browse_integrations - Remove per_page from non-paginated actions (get, job, logs, content, compare) - Remove ref from manage_pipeline retry/cancel (only needed for create) - Fix manage_ref params: delete_branch uses branch only, protect_branch uses name, create_tag uses tag_name+ref - Use limit instead of per_page for job logs - Update manage_webhook actions (remove 'read'), manage_integration (remove 'get')
- browse_webhooks: use action "list" instead of empty string - browse_integrations: add required action "list" field - create_branch: remove action field from standalone tool usage - manage_ref protect_branch: use name param, remove branch/ref - manage_ref create_tag: remove invalid branch param - browse_milestones: use "issues" action for milestone filtering - Restore CLI nav link in config.mts - Rename "Related Guides" section to "Related" where mixed
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 31 out of 31 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
docs/.vitepress/config.mts:19
- The top nav links to
/cli/list-tools, but thesidebarconfig no longer defines a/cli/section. This makes CLI pages render without a sidebar (and can strand users if more CLI pages are added). Consider re-adding a/cli/sidebar group (or removing the CLI nav item if intentional).
nav: [
{ text: "Guide", link: "/guide/" },
{ text: "Tools", link: "/tools/" },
{ text: "Prompts", link: "/prompts/" },
{ text: "Guides", link: "/guides/" },
{ text: "Security", link: "/security/oauth" },
{ text: "Advanced", link: "/advanced/tls" },
{ text: "CLI", link: "/cli/list-tools" },
],
- list_group_iterations: remove action field (flat schema, no action) - browse_work_items get: remove state/first/simple (list-only params) - manage_merge_request approve/merge/update/get_approval_state: remove source_branch (not accepted by these actions) - manage_work_item update: remove namespace/workItemType (only id accepted)
- manage_draft_notes publish_all: remove invalid note field - manage_webhook description: replace CRUD with actual actions - manage_integration description: remove get (moved to browse_integrations) - setup-ci-notifications: use browse_integrations for get action
- Switch fenced blocks with // annotations to jsonc language - GITLAB_API_URL: use base URL without /api/v4 suffix - manage_ref: add update_branch_protection and unprotect_tag actions - create_branch: standalone tool, not alias - project-management: label browse_members example explicitly
- Access level tables: add 0=No access and 5=Minimal - Suggestion examples: use conventional commit format in commit_message
…-library-and-advanced-site-features-pha
…s-pha' of github.com:structured-world/gitlab-mcp into feat/#125-docs-prompt-library-and-advanced-site-features-pha
polaz
added a commit
that referenced
this pull request
Jan 23, 2026
* docs: add Prompt Library, guides, llms.txt, and use-case tool pages (#125) - Prompt Library with 16 pages of ready-to-use prompts organized by workflow (quick-start, code-review, CI/CD, project-management) and by role (developer, devops, team-lead, PM) - 4 step-by-step guides: code review, CI notifications, multi-GitLab setup, team onboarding - llms.txt for machine-readable documentation summary - Tool pages reorganized by use-case: code-review, ci-cd, project-management, repository - VitePress nav/sidebar updated with Prompts and Guides sections - Homepage updated with Prompt Library action button * docs: add Automate Releases guide and tool comparison tables - Add 5th guide: automate-releases.md (end-to-end release workflow) - Add tool comparison table by role (Developer/DevOps/Lead/PM) - Add Query vs Command comparison table for CQRS tools - Update sidebar and guides index with new guide * fix(docs): correct tool schemas in prompt library and guides - Rename list_webhooks/list_integrations to browse_webhooks/browse_integrations - Remove per_page from non-paginated actions (get, job, logs, content, compare) - Remove ref from manage_pipeline retry/cancel (only needed for create) - Fix manage_ref params: delete_branch uses branch only, protect_branch uses name, create_tag uses tag_name+ref - Use limit instead of per_page for job logs - Update manage_webhook actions (remove 'read'), manage_integration (remove 'get') * fix(docs): correct tool action params and restore CLI nav - browse_webhooks: use action "list" instead of empty string - browse_integrations: add required action "list" field - create_branch: remove action field from standalone tool usage - manage_ref protect_branch: use name param, remove branch/ref - manage_ref create_tag: remove invalid branch param - browse_milestones: use "issues" action for milestone filtering - Restore CLI nav link in config.mts - Rename "Related Guides" section to "Related" where mixed * fix(docs): add CLI sidebar section for /cli/ pages * fix(docs): remove invalid params from tool examples - list_group_iterations: remove action field (flat schema, no action) - browse_work_items get: remove state/first/simple (list-only params) - manage_merge_request approve/merge/update/get_approval_state: remove source_branch (not accepted by these actions) - manage_work_item update: remove namespace/workItemType (only id accepted) * fix(docs): correct publish_all, webhook, and integration examples - manage_draft_notes publish_all: remove invalid note field - manage_webhook description: replace CRUD with actual actions - manage_integration description: remove get (moved to browse_integrations) - setup-ci-notifications: use browse_integrations for get action * fix(docs): clarify tool references and descriptions - project-management: add missing list_project_members tool to table - repository: reorder create_branch as convenience alias of manage_ref - debug-failure: add tool name comments to distinguish manage_pipeline from manage_pipeline_job - multi-gitlab-setup: fix reset description (restores full context, not just scope) * fix(docs): use jsonc lang tag, correct API URL and tool schemas - Switch fenced blocks with // annotations to jsonc language - GITLAB_API_URL: use base URL without /api/v4 suffix - manage_ref: add update_branch_protection and unprotect_tag actions - create_branch: standalone tool, not alias - project-management: label browse_members example explicitly * fix(docs): add missing access levels and use conventional commits - Access level tables: add 0=No access and 5=Minimal - Suggestion examples: use conventional commit format in commit_message * fix(docs): add missing draft action and use conventional commit format
|
🎉 This PR is included in version 6.33.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
polaz
added a commit
that referenced
this pull request
Jan 23, 2026
* feat(availability): extend tier matrix with per-parameter gating (#136) Add parameter-level tier restrictions to the schema filtering pipeline. Parameters above the user's GitLab tier are stripped from JSON Schema before exposure to agents, preventing confusing API errors. - Add parameterRequirements map to ToolAvailability (manage_work_item: weight, iterationId, healthStatus) - Add getRestrictedParameters() method checking tier and version - Add stripTierRestrictedParameters() utility in schema-utils for both flat and discriminated union schemas - Integrate parameter stripping in registry-manager buildToolLookupCache pipeline * refactor(availability): add ParameterRequirement alias and improve debug log - Add ParameterRequirement type alias for semantic clarity (vs ActionRequirement) - Include version in restricted parameters debug log since parameters can be restricted by version, not just tier * test(availability): add parameter stripping edge case tests - Add RegistryManager test for schema property removal integration - Add schema-utils tests: no properties, no required array, discriminated union with missing properties branch * fix(availability): log raw version string and clean up test registry - Use human-readable version string (e.g. "17.0.0") in debug log instead of parsed numeric value (1700) - Wrap parameter stripping test in try/finally to clean up shared registry after test completes * docs: Prompt Library and advanced site features (Phase 2) (#143) * docs: add Prompt Library, guides, llms.txt, and use-case tool pages (#125) - Prompt Library with 16 pages of ready-to-use prompts organized by workflow (quick-start, code-review, CI/CD, project-management) and by role (developer, devops, team-lead, PM) - 4 step-by-step guides: code review, CI notifications, multi-GitLab setup, team onboarding - llms.txt for machine-readable documentation summary - Tool pages reorganized by use-case: code-review, ci-cd, project-management, repository - VitePress nav/sidebar updated with Prompts and Guides sections - Homepage updated with Prompt Library action button * docs: add Automate Releases guide and tool comparison tables - Add 5th guide: automate-releases.md (end-to-end release workflow) - Add tool comparison table by role (Developer/DevOps/Lead/PM) - Add Query vs Command comparison table for CQRS tools - Update sidebar and guides index with new guide * fix(docs): correct tool schemas in prompt library and guides - Rename list_webhooks/list_integrations to browse_webhooks/browse_integrations - Remove per_page from non-paginated actions (get, job, logs, content, compare) - Remove ref from manage_pipeline retry/cancel (only needed for create) - Fix manage_ref params: delete_branch uses branch only, protect_branch uses name, create_tag uses tag_name+ref - Use limit instead of per_page for job logs - Update manage_webhook actions (remove 'read'), manage_integration (remove 'get') * fix(docs): correct tool action params and restore CLI nav - browse_webhooks: use action "list" instead of empty string - browse_integrations: add required action "list" field - create_branch: remove action field from standalone tool usage - manage_ref protect_branch: use name param, remove branch/ref - manage_ref create_tag: remove invalid branch param - browse_milestones: use "issues" action for milestone filtering - Restore CLI nav link in config.mts - Rename "Related Guides" section to "Related" where mixed * fix(docs): add CLI sidebar section for /cli/ pages * fix(docs): remove invalid params from tool examples - list_group_iterations: remove action field (flat schema, no action) - browse_work_items get: remove state/first/simple (list-only params) - manage_merge_request approve/merge/update/get_approval_state: remove source_branch (not accepted by these actions) - manage_work_item update: remove namespace/workItemType (only id accepted) * fix(docs): correct publish_all, webhook, and integration examples - manage_draft_notes publish_all: remove invalid note field - manage_webhook description: replace CRUD with actual actions - manage_integration description: remove get (moved to browse_integrations) - setup-ci-notifications: use browse_integrations for get action * fix(docs): clarify tool references and descriptions - project-management: add missing list_project_members tool to table - repository: reorder create_branch as convenience alias of manage_ref - debug-failure: add tool name comments to distinguish manage_pipeline from manage_pipeline_job - multi-gitlab-setup: fix reset description (restores full context, not just scope) * fix(docs): use jsonc lang tag, correct API URL and tool schemas - Switch fenced blocks with // annotations to jsonc language - GITLAB_API_URL: use base URL without /api/v4 suffix - manage_ref: add update_branch_protection and unprotect_tag actions - create_branch: standalone tool, not alias - project-management: label browse_members example explicitly * fix(docs): add missing access levels and use conventional commits - Access level tables: add 0=No access and 5=Minimal - Suggestion examples: use conventional commit format in commit_message * fix(docs): add missing draft action and use conventional commit format * fix(availability): optimize instance info lookup and refresh cache after init - Accept optional pre-fetched instanceInfo in getRestrictedParameters() to avoid redundant ConnectionManager calls per tool in cache build loop - Pre-fetch instance info once at the start of buildToolLookupCache() - Refresh registry cache after successful ConnectionManager initialization so tier-restricted parameters are stripped even if RegistryManager was constructed before connection was available - Invalidate toolDefinitionsCache in refreshCache() for consistency * fix(availability): guard parameter stripping when connection unavailable - Skip getRestrictedParameters call when instanceInfo is undefined to avoid repeated throw/catch in ConnectionManager.getInstanceInfo() - Use invalidateCaches() in refreshCache() to clear all derived caches (toolNamesCache, readOnlyToolsCache) consistently - Add ConnectionManager mock to RegistryManager and ToolDescriptionOverrides tests so buildToolLookupCache can pre-fetch instance info * test(availability): cover cachedInstanceInfo branch and uninitialized guard - Add tests for getRestrictedParameters with cachedInstanceInfo parameter (tier check, version check, bypassing ConnectionManager) - Add RegistryManager test verifying parameter stripping is skipped when ConnectionManager is not initialized * fix(schema-utils): always filter required array in stripFromProperties - Restructure stripFromProperties to handle required filtering independently from properties deletion - Add mockClear() in RegistryManager test to prevent stale call history - Add test case for schema with required but no properties object
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
llms.txtat site root for machine-readable documentation (all 47 tools listed)code-groupthroughoutCloses #125
Test plan
vitepress build docspasses without errors/llms.txt