fix: improve documentation

Author: hashemix

README.md

@@ -6,12 +6,8 @@
 
 A command-line tool written in Rust for discovering and documenting MCP Server capabilities.
 
-`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.
+It supports outputting the results in the terminal or saving them to files in [Markdown](https://github.com/rust-mcp-stack/mcp-discovery/blob/main/docs/examples/update-md.md#server-info-and-capabilities), [HTML](https://rust-mcp-stack.github.io/mcp-discovery/examples/server-info.html), [plain text](https://rust-mcp-stack.github.io/mcp-discovery/examples/capabilities.txt), JSON, or a custom template defined by you.
 
-🌐 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).
 
@@ -23,6 +19,11 @@ Check the [project documentation](https://rust-mcp-stack.github.io/mcp-discovery
 - **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.
 
+
+<img align="top" src="docs/_media/rust-mcp-stack-icon.png" width="24" style="border-radius:0.2rem;"> This open-source project leverages the [rust-mcp-sdk](https://github.com/rust-mcp-stack/rust-mcp-sdk) for seamless interaction with MCP Servers.
+
+🌐 Check out the **rust-mcp-filesystem** [capabilities](https://rust-mcp-stack.github.io/rust-mcp-filesystem/#/capabilities) page for a sample output.
+
 ## Installation ⬇️
 
 ### Running as CLI
@@ -31,7 +32,7 @@ Check the [project documentation](https://rust-mcp-stack.github.io/mcp-discovery
 
 ### GitHub Action
 
-The easiest way to automate and maintain up-to-date MCP Server documentation , is to use mcp-discovery as a 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
@@ -105,8 +106,8 @@ mcp-discovery create -f capabilities.md  --template-file=custom_template.hbs --
 
 ## Defining Update Regions with Markers
 
-When using the `update` subcommand, `mcp-discovery` places capabilities between designated markers in the target file, which vary by file format and are typically comment lines.  
-The update command simplifies the process for developers and maintainers to keep documentation current effortlessly.  
+When using the `update` subcommand, `mcp-discovery` places capabilities between designated markers in the target file, which vary by file format and are typically comment lines.
+The update command simplifies the process for developers and maintainers to keep documentation current effortlessly.
 Run the mcp-discovery update command anytime to refresh the file with the latest MCP Server capabilities.
 
 ### Marker Annotations
@@ -188,7 +189,7 @@ Server Capabilities will be placed here...
     <b>Name: </b>{{name}}
     <br/>
     <b>Version: </b>{{version}}
-    <br/>      
+    <br/>
     <b>Number of tools:</b> {{len tools}}
     <h2>Summary:</h2>
     {{> html-summary }}

docs/README.md

@@ -3,11 +3,9 @@
 A command-line tool written in Rust for discovering and documenting MCP Server capabilities.
 
 `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.
+It supports outputting the results in the terminal or saving them to files in [Markdown](https://github.com/rust-mcp-stack/mcp-discovery/blob/main/docs/examples/update-md.md#server-info-and-capabilities), [HTML](https://rust-mcp-stack.github.io/mcp-discovery/examples/server-info.html), [plain text](https://rust-mcp-stack.github.io/mcp-discovery/examples/capabilities.txt), JSON, or a custom template defined by you.
 
-🌐 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).
 
 ## Features 💡
 
@@ -17,15 +15,53 @@ This project is open-source and leverages the [rust-mcp-schema](https://github.c
 - **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.
 
+<img align="top" src="_media/rust-mcp-stack-icon.png" width="24" style="border-radius:0.2rem;"> This open-source project leverages the [rust-mcp-sdk](https://github.com/rust-mcp-stack/rust-mcp-sdk) for seamless interaction with MCP Servers.
+
+🌐 Check out the **rust-mcp-filesystem** [capabilities](https://rust-mcp-stack.github.io/rust-mcp-filesystem/#/capabilities) page for a sample output.
+
 ## Installation ⬇️
 
 ### Running as CLI
 
-Refer to the [quickstart](quickstart.md) guide for installation and command line options.
+
+##### **Shell script**
+
+<!-- x-release-please-start-version -->
+
+```sh
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/rust-mcp-stack/mcp-discovery/releases/download/v0.2.0/mcp-discovery-installer.sh | sh
+```
+
+##### **PowerShell script**
+
+```sh
+powershell -ExecutionPolicy Bypass -c "irm https://github.com/rust-mcp-stack/mcp-discovery/releases/download/v0.2.0/mcp-discovery-installer.ps1 | iex"
+```
+
+<!-- x-release-please-end -->
+
+##### **Homebrew**
+
+```sh
+brew install rust-mcp-stack/tap/mcp-discovery
+```
+
+##### **Cargo**
+
+```sh
+cargo install mcp-discovery --locked
+```
+
+##### **NPM**
+
+```sh
+npm i -g @rustmcp/mcp-discovery@latest
+```
+> The npm package is provided for convenience. It runs the same underlying Rust binary but can be installed and used as a standard npm package.
 
 ### GitHub Action
 
-The easiest way to automate and maintain up-to-date MCP Server documentation , is to use mcp-discovery as a 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

docs/_coverpage.md

@@ -16,7 +16,7 @@
 - ⚙️ CI/CD-friendly
 
 [GitHub](https://github.com/rust-mcp-stack/mcp-discovery)
-[Install](https://rust-mcp-stack.github.io/mcp-discovery#/quickstart)
+[Install](https://rust-mcp-stack.github.io/mcp-discovery#quickstart)
 [Get Started](#mcp-discovery)
 
 <!-- background color -->

docs/_media/rust-mcp-stack-icon.png

@@ -0,0 +1,75 @@
+example-servers/everything 1.0.0
+
+🟢 Tools (10)   🟢 Prompts (3) 🟢 Resources (10)   🟢 Logging 🟢 Completions  🔴 Experimental
+
+   
+
+🛠️ Tools (10)
+─────────────
+
+1. add : Adds two numbers
+
+2. annotatedMessage : Demonstrates how annotations can be used to provide metadata about content
+
+3. echo : Echoes back the input
+
+4. getResourceLinks : Returns multiple resource links that reference different types of resources
+
+5. getResourceReference : Returns a resource reference that can be used by MCP clients
+
+6. getTinyImage : Returns the MCP_TINY_IMAGE
+
+7. longRunningOperation : Demonstrates a long running operation with progress updates
+
+8. printEnv : Prints all environment variables, helpful for debugging MCP server configuration
+
+9. sampleLLM : Samples from an LLM using MCP's sampling feature
+
+10. structuredContent : Returns structured content along with an output schema for client data validation
+
+
+
+📝 Prompts (3)
+──────────────
+
+1. simple_prompt : A prompt without arguments
+
+2. complex_prompt : A prompt with arguments
+
+3. resource_prompt : A prompt that includes an embedded resource reference
+
+
+
+📄 Resources (10)
+─────────────────
+
+1. Resource 1 : test://static/resource/1 (text/plain)
+
+2. Resource 2 : test://static/resource/2 (application/octet-stream)
+
+3. Resource 3 : test://static/resource/3 (text/plain)
+
+4. Resource 4 : test://static/resource/4 (application/octet-stream)
+
+5. Resource 5 : test://static/resource/5 (text/plain)
+
+6. Resource 6 : test://static/resource/6 (application/octet-stream)
+
+7. Resource 7 : test://static/resource/7 (text/plain)
+
+8. Resource 8 : test://static/resource/8 (application/octet-stream)
+
+9. Resource 9 : test://static/resource/9 (text/plain)
+
+10. Resource 10 : test://static/resource/10 (application/octet-stream)
+
+
+
+🧩 Resource Templates (1)
+─────────────────────────
+
+1. Static Resource : test://static/resource/{id}  
+   A static resource with a numeric ID
+
+
+◾ generated by mcp-discovery

docs/examples/capabilities.txt

@@ -43,19 +43,27 @@ Server Name: example-servers/everything, Server Version: 1.0.0
 
 #### ▪️ Print MCP Server capabilities to the terminal as JSON:
 
-We use the `json` helper function as a template string. It accepts an optional boolean argument—when set to true, the output is pretty-printed:
+We use the `json` helper function in a template string. It accepts an object and optional second parameter with value of 'pretty' for a formatted output:
 
+
+- Print the Full MCP Server Capabilities to the Terminal in JSON Format:
 ```bash
-mcp-discovery --template-string "{{{json true}}}" -- npx -y @modelcontextprotocol/server-everything
+mcp-discovery --template-string "{{{json this}}}" -- npx -y @modelcontextprotocol/server-everything
 ```
-
 <a href="examples/json.txt" target="_blank"> 📎 printed json</a>
 
+- Print MCP Server tools to the Terminal in pretty-formatted JSON :
+```bash
+mcp-discovery --template-string "{{{json this.tools}}}" -- npx -y @modelcontextprotocol/server-everything
+```
+
+
+
 ---
 
 ## Create
 
-#### Create a Markdown file (\*.md) with MCP Server capabilities:
+#### Create a Markdown file (\*.md) describing MCP Server capabilities:
 
 ```bash
 mcp-discovery create -f create-md.md -- npx -y @modelcontextprotocol/server-everything
@@ -77,14 +85,23 @@ mcp-discovery create -f create-md-plain.md --template md-plain -- npx -y @modelc
 
 ---
 
-#### Create a HTML file (\*.html) with MCP Server capabilities:
+#### Create a HTML file (\*.html) describing MCP Server capabilities:
 
 ```bash
 mcp-discovery create -f server-info.html -- npx -y @modelcontextprotocol/server-everything
 ```
 
 <a href="examples/server-info.html" target="_blank">📎 view generated file</a>
 
+#### Create a TEXT file (\*.txt) describing MCP Server capabilities:
+
+```bash
+mcp-discovery create -f capabilities.txt -- npx -y @modelcontextprotocol/server-everything
+```
+
+<a href="examples/capabilities.txt" target="_blank">📎 view generated file</a>
+
+
 ## Update
 
 To update files, you need to annotate a [render block](./guide/mcp-discovery-markers.md) within the target file where the MCP server capabilities should be inserted.
@@ -96,7 +113,7 @@ Refer to the ["Update Regions with Markers"](./guide/mcp-discovery-markers.md) p
 mcp-discovery update -f update-md.md -- npx -y @modelcontextprotocol/server-everything
 ```
 
-Below is a typical md file containing a render block marked with `<!-- mcp-discovery-render -->` and `<!-- mcp-discovery-render-end -->`.  
+Below is a typical md file containing a render block marked with `<!-- mcp-discovery-render -->` and `<!-- mcp-discovery-render-end -->`.
 MCP Discovery will overwrite the content between these markers with the latest generated output.
 
 ```md

docs/guide/command-examples.md

@@ -32,6 +32,12 @@ brew install rust-mcp-stack/tap/mcp-discovery
 cargo install mcp-discovery --locked
 ```
 
+#### **NPM**
+
+```sh
+npm i -g @rustmcp/mcp-discovery@latest
+```
+
 #### **Download Binaries**
 
 <table>
@@ -43,7 +49,7 @@ cargo install mcp-discovery --locked
     </tr>
   </thead>
   <tbody>
-    <tr>      
+    <tr>
       <td>
       <!-- x-release-please-start-version -->
       <a href="https://github.com/rust-mcp-stack/mcp-discovery/releases/download/v0.2.1/mcp-discovery-aarch64-apple-darwin.tar.gz">mcp-discovery-aarch64-apple-darwin.tar.gz</a>