feat: add mcp discovery GitHub action

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+### 📌 Summary
+<!-- Provide a concise description of your changes. What problem does this PR solve? -->
+
+### 🔍 Related Issues
+<!-- Link related issues using keywords like "Fixes #123" or "Closes #456" -->
+
+- Fixes #
+
+
+### ✨ Changes Made
+<!-- List the key changes introduced in this PR -->
+
+- Change 1
+- Change 2
+- Change 3
+
+### 🛠️ Testing Steps
+<!-- Explain how reviewers can test your changes, if applicable -->
+
+### 💡 Additional Notes
+<!-- Any other information or context about the PR -->

.github/workflows/ci.yml

@@ -12,6 +12,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Cache Rust
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.rustup/toolchains
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-rust-${{ steps.toolchain.outputs.cachekey }}
+          restore-keys: ${{ runner.os }}-rust-
 
       - name: Install Rust Toolchain
         uses: dtolnay/rust-toolchain@master

README.md

@@ -9,6 +9,8 @@ A command-line tool written in Rust for discovering and documenting MCP Server c
 `mcp-discovery` launches an MCP Server using provided commands, queries its capabilities, tools, resources etc.
 It supports outputting the results in the terminal or saving them to files in Markdown, HTML, or plain text formats.
 
+🌐 Check out the **rust-mcp-filesystem** [capabilities](https://rust-mcp-stack.github.io/rust-mcp-filesystem/#/capabilities) page for sample output.
+
 This project is open-source and leverages the [rust-mcp-schema](https://github.com/rust-mcp-stack/rust-mcp-schema) and [rust-mcp-sdk](https://github.com/rust-mcp-stack/rust-mcp-sdk) crates for seamless interaction with MCP Servers.
 
 Check the [project documentation](https://rust-mcp-stack.github.io/mcp-discovery) for instructions and [command examples](https://rust-mcp-stack.github.io/mcp-discovery/#/guide/command-examples).
@@ -19,11 +21,19 @@ Check the [project documentation](https://rust-mcp-stack.github.io/mcp-discovery
 - **Generate Files**: Create files in Markdown (`.md`), HTML (`.html`), or plain text (`.txt`) formats with MCP Server details and capabilities.
 - **Update Files**: Modify existing Markdown, HTML, or text files by adding MCP Server capabilities within specified markers, enabling MCP Server developers to automatically maintain up-to-date documentation and repository README files.
 - **Flexible Output Customization**: Choose from built-in templates (`md`, `md-plain`, `html`, `txt`) or supply custom Handlebars templates for personalized output.
+- **MCP Discovery GitHub Action**: Integrate the mcp-discovery CLI as a GitHub Action to automate and maintain up-to-date MCP Server documentation in your development workflow.
 
 ## Installation ⬇️
 
+### Running as CLI
+
 Check the [project documentation](https://rust-mcp-stack.github.io/mcp-discovery) for instructions on installing the tool on different platforms.
 
+### GitHub Action
+
+The easiest way to automate and maintain up-to-date MCP Server documentation , is to use mcp-discovery as a GitHub action.  
+Please see [rust-mcp-stack/mcp-discovery-action](https://github.com/rust-mcp-stack/mcp-discovery-action) for installation and configuration instructions.
+
 ## Subcommands
 
 - **`print`**: Displays MCP Server capabilities in the terminal.

docs/README.md

@@ -5,6 +5,8 @@ A command-line tool written in Rust for discovering and documenting MCP Server c
 `mcp-discovery` launches an MCP Server using provided commands, queries its capabilities, tools, resources etc.
 It supports outputting the results in the terminal or saving them to files in Markdown, HTML, or plain text formats.
 
+🌐 Check out the **rust-mcp-filesystem** [capabilities](https://rust-mcp-stack.github.io/rust-mcp-filesystem/#/capabilities) page for sample output.
+
 This project is open-source and leverages the [rust-mcp-schema](https://github.com/rust-mcp-stack/rust-mcp-schema) and [rust-mcp-sdk](https://github.com/rust-mcp-stack/rust-mcp-sdk) crates for seamless interaction with MCP Servers.
 
 ## Features 💡
@@ -13,11 +15,19 @@ This project is open-source and leverages the [rust-mcp-schema](https://github.c
 - **Generate Files**: Create files in Markdown (`.md`), HTML (`.html`), or plain text (`.txt`) formats with MCP Server details and capabilities.
 - **Update Files**: Modify existing Markdown, HTML, or text files by adding MCP Server capabilities within specified markers, enabling MCP Server developers to automatically maintain up-to-date documentation and repository README files.
 - **Flexible Output Customization**: Choose from built-in templates (`md`, `md-plain`, `html`, `txt`) or supply custom Handlebars templates for personalized output.
+- **MCP Discovery GitHub Action**: Integrate the mcp-discovery CLI as a GitHub Action to automate and maintain up-to-date MCP Server documentation in your development workflow.
+
+## Installation ⬇️
 
-## Quick Start
+### Running as CLI
 
 Refer to the [quickstart](quickstart.md) guide for installation and command line options.
 
+### GitHub Action
+
+The easiest way to automate and maintain up-to-date MCP Server documentation , is to use mcp-discovery as a GitHub action.  
+Please see [rust-mcp-stack/mcp-discovery-action](https://github.com/rust-mcp-stack/mcp-discovery-action) for installation and configuration instructions.
+
 ## Example
 
 - Print MCP Server capabilities to the terminal: