What is Mcp Discovery Action

mcp-discovery-action is a GitHub Action designed to run the MCP Discovery CLI, which is used for creating, updating, or printing MCP server capability details in various formatted files such as Markdown.

Use cases

Use cases for mcp-discovery-action include generating documentation for MCP server capabilities, updating existing documentation automatically during CI/CD processes, and printing server capability details for review.

How to use

To use mcp-discovery-action, define the action in your GitHub workflow YAML file, specifying the required inputs such as the command to run (create, update, or print), the MCP launch command, and optionally the output file path and template type.

Key features

Key features of mcp-discovery-action include support for all CLI options, built-in templates for output formats (Markdown, HTML, etc.), the ability to use custom Handlebars templates, and automatic downloading of the latest CLI version.

Where to use

mcp-discovery-action can be used in software development environments, particularly for projects that involve MCP servers, to automate the documentation of server capabilities.

MCP Discovery Action

A GitHub Action to run the MCP Discovery CLI for creating, updating or printing MCP server capability details in a Markdown or other formatted file.

💡 Check out the rust-mcp-filesystem capabilities page for sample output and an example workflow: mcp-discovery.yml.

Overview

This action runs the MCP Discovery CLI to discover MCP server capabilities and create/update a file with MCP server details (create or update commands). It supports all CLI options, including built-in templates (md, md-plain, html, txt), custom Handlebars template files, or template strings.

The action downloads the latest version of the CLI binary by default, but you can specify a specific version using the action’s version input.

Inputs

💡 For more information and command examples, refer to the MCP Discovery documentation.

Usage

Example 1: Create a Markdown File

Create mcp-discovery.md with MCP server capabilities and commit it if changed.

name: MCP Discovery (create)
on:
  push:
    branches:
      - main
permissions:
  contents: write
jobs:
  generate-md:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - uses: rust-mcp-stack/mcp-discovery-action@v1
        with:
          version: 'latest'
          command: 'create'
          mcp-launch-command: '[THE COMMAND YOU USE TO START YOUR MCP SERVER]'
          filename: 'mcp-discovery.md'

Example 2: Update a designated section of the README.md file

💡 For more information about update command and template markers, visit MCP Discovery documentation.

name: MCP Discovery (update)
on:
  push:
    branches:
      - main
permissions:
  contents: write
jobs:
  generate-md:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - uses: rust-mcp-stack/mcp-discovery-action@v1
        with:
          version: 'latest'
          command: 'update'
          mcp-launch-command: '[THE COMMAND YOU USE TO START YOUR MCP SERVER]'
          filename: 'README.md'

Contributing

Contributions are welcome! Please open an issue or pull request in the mcp-discovery-action repository.

License

MIT License. See LICENSE for details.