Skip to content

Commit efbfe79

Browse files
committed
chore: update documentation
1 parent 85d0519 commit efbfe79

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

.github/pull_request_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
### 📌 Summary
2+
<!-- Provide a concise description of your changes. What problem does this PR solve? -->
3+
4+
### 🔍 Related Issues
5+
<!-- Link related issues using keywords like "Fixes #123" or "Closes #456" -->
6+
7+
- Fixes #
8+
9+
10+
### ✨ Changes Made
11+
<!-- List the key changes introduced in this PR -->
12+
13+
- Change 1
14+
- Change 2
15+
- Change 3
16+
17+
### 🛠️ Testing Steps
18+
<!-- Explain how reviewers can test your changes, if applicable -->
19+
20+
### 💡 Additional Notes
21+
<!-- Any other information or context about the PR -->

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A GitHub Action to run the [MCP Discovery](https://github.com/rust-mcp-stack/mcp-discovery) CLI for creating, updating or printing MCP server capability details in a Markdown or other formatted file.
44

5+
💡 Check out the **rust-mcp-filesystem** [capabilities](https://rust-mcp-stack.github.io/rust-mcp-filesystem/#/capabilities) page for sample output.
6+
57
## Overview
68

79
This action runs the [MCP Discovery](https://github.com/rust-mcp-stack/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.
@@ -11,7 +13,7 @@ The action downloads the latest version of the CLI binary by default, but you ca
1113
## Inputs
1214

1315
| Input | Description | Required | Default |
14-
| -------------------- | ------------------------------------------------------------------------------------------------ | -------- | --------------------- |
16+
| --- | --- | --- | --- |
1517
| `command` | CLI command to run (`create`, `update` or `print`). | Yes | - |
1618
| `mcp-launch-command` | Command and arguments to launch the MCP server (e.g., `java -jar mcp.jar`). | Yes | - |
1719
| `filename` | Output file path for `create`/`update` commands (e.g., `docs/mcp-details.md`). | No | `mcp-discovery.md` |

0 commit comments

Comments
 (0)