Document "GitLab: Show MCP Dashboard" command in MCP clients documentation

Summary

The GitLab: Show MCP Dashboard command was introduced in GitLab Workflow extension v6.55.0 (2025-11-06) but is not documented in the MCP clients user guide.

Documentation URL: https://docs.gitlab.com/user/gitlab_duo/model_context_protocol/mcp_clients/

Related VSCode Extension Issue: gitlab-vscode-extension#2183 (closed)

Problem

Users have no documentation about:

  • How to view MCP server status
  • What information the dashboard displays
  • How to use it for troubleshooting
  • Version requirements

The documentation currently only mentions:

  • ✅ GitLab MCP: Open User Settings (JSON) command
  • ✅ GitLab MCP: Open Workspace Settings (JSON) command
  • ❌ Missing: GitLab: Show MCP Dashboard command

Proposed Solution

Add a new task topic "View MCP server status" to doc/user/gitlab_duo/model_context_protocol/mcp_clients.md.

Topic Type

Task - Follows the task topic format

Insert Location

After "Configure MCP servers" section, before "Use GitLab Duo features with MCP" section (approximately line 200)

Complete Proposed Documentation

The following content follows the GitLab Documentation Style Guide:

## View MCP server status

{{< history >}}

- [Introduced](https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/commit/37ef3b55cb2f972cf4baebb215a9304c60f68880) in GitLab Workflow extension 6.55.0.

{{< /history >}}

View the status of your configured MCP servers to verify connections and troubleshoot issues.

Prerequisites:

- You must have GitLab Workflow extension version 6.55.0 or later installed.
- You must have at least one MCP server configured in your user or workspace configuration.

To view MCP server status:

1. Open the Command Palette:
   - On macOS, press <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>.
   - On Windows or Linux, press <kbd>Control</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>.
1. Run the command `GitLab: Show MCP Dashboard`.

The MCP Dashboard opens in a new editor tab.

### Information displayed in the dashboard

The dashboard displays:

- All configured MCP servers from your user and workspace configurations.
- Connection status for each server:

  Connected
  : Server is ready and tools are available to GitLab Duo features.

  Connecting
  : Attempting to establish connection to the server.

  Authenticating
  : OAuth authentication in progress. An authorization URL is displayed.

  Failed
  : Connection error occurred. Error details are displayed for troubleshooting.

  Disconnected
  : Server is not connected.

- Server configuration details, including type, command, and URL.
- Available tools and resources from each connected server.
- Connection logs and error messages.

Use the dashboard to:

- Verify your MCP servers are properly configured and connected.
- Monitor server health and connection status.
- Troubleshoot connection issues with detailed error messages.
- View which tools are available to GitLab Duo features.

### Open MCP configuration files

To quickly access your MCP configuration files from the Command Palette:

- Run `GitLab MCP: Open User Settings (JSON)` to open `~/.gitlab/duo/mcp.json`.
- Run `GitLab MCP: Open Workspace Settings (JSON)` to open `<workspace>/.gitlab/duo/mcp.json`.

These commands create the configuration file with helpful examples if it does not exist.

Style Guide Compliance

This content follows GitLab documentation standards:

Task Topic Format

  • ✅ Title uses active verb + noun: "View MCP server status"
  • ✅ Introduction explains when to use: "View the status... to verify connections and troubleshoot issues"
  • ✅ Prerequisites listed (plural, even with one item)
  • ✅ Task steps use "To [action]:" format
  • ✅ Steps use location-then-action pattern

Text Formatting

  • ✅ UI elements in bold: Command Palette, GitLab Duo
  • ✅ Commands in backticks: GitLab: Show MCP Dashboard
  • ✅ Keyboard shortcuts use <kbd> tags
  • ✅ No bold for emphasis, only for UI elements

Lists and Structure

  • ✅ Description list for connection states (Term: Definition format)
  • ✅ Unordered list for use cases (parallel structure)
  • ✅ All list items start with capital letter
  • ✅ Periods after complete sentences

Shortcodes

  • ✅ {{< history >}} for version tracking
  • ✅ Proper shortcode formatting with spaces

Language

  • ✅ Clear, concise, active voice
  • ✅ No unnecessary words
  • ✅ Avoids "there is/are" constructions
  • ✅ Uses "you must" for prerequisites

File to Update

Path: doc/user/gitlab_duo/model_context_protocol/mcp_clients.md

Estimated Addition: ~60 lines

Acceptance Criteria

  • New section "View MCP server status" added to mcp_clients.md
  • Content follows task topic format
  • Prerequisites listed correctly
  • UI elements properly formatted in bold
  • Keyboard shortcuts use <kbd> tags
  • Description list used for connection states
  • Version history included with {{< history >}} shortcode
  • Screenshots added (when dashboard UI is available)
  • Technical writing review completed
  • Docs preview verified
  • Vale linting passes

Technical References

Code Implementation

Related Commits

Related Documentation

Edited by 🤖 GitLab Bot 🤖