Merge pull request #996 from Kyoungwoong/feature/smithery-readme

fix: README

Author: Kyoungwoong

packages/mcp/descriptions/githru-dev-description.md

@@ -10,13 +10,13 @@ Deployed as a **remote MCP server** via Smithery, allowing direct connection and
 ``` 
 githru-vscode-ext/
 └─ packages/
-  └─ githru-mcp/
-  ├─ src/
-  │ └─ index.ts
-  ├─ smithery.yml
-  ├─ package.json
-  ├─ tsconfig.json
-  └─ .gitignore
+  └─ mcp/
+    ├─ src/
+    │ └─ index.ts
+    ├─ smithery.yml
+    ├─ package.json
+    ├─ tsconfig.json
+    └─ .gitignore
 ```
 
 ---
@@ -25,18 +25,7 @@ githru-vscode-ext/
 
 Since githru-mcp is deployed on Smithery, you can use the remote MCP server directly without any build or local execution.
 
-1. Access the remote server page  
-   👉 [https://server.smithery.ai/@Kyoungwoong/githru-vscode-ext/mcp](https://server.smithery.ai/@Kyoungwoong/githru-vscode-ext/mcp)
-
-2. Click the **"Add to Claude"** button  
-   - Automatically registers to Claude Desktop.  
-   - If failed, you can manually add it in Claude Desktop settings.  
-
-3. Use MCP tools after restarting Claude Desktop  
-   - Available tool examples:
-     - `ping` → Server health check (returns "pong")
-     - `echo` → Returns input text as-is
-     - `bmi_calculator` → Input height/weight → Returns BMI calculation result
+[Abount Details](./smithery-description.md)
 
 ---
 

packages/mcp/descriptions/smithery-description.md

@@ -4,63 +4,87 @@
   <strong>A powerful Model Context Protocol (MCP) server that provides advanced Git repository analysis and visualization tools designed to enhance team collaboration.</strong>
 </p>
 
-## 🎯 Core Features
+---
 
-### 📊 Feature Impact Analyzer
+## 🚀 Overview
 
-Analyzes GitHub Pull Requests to compute comprehensive impact metrics such as **scale, dispersion, chaos, isolation, lag, and coupling**.
-It features **long-tail–based analysis** to identify outlier file paths and generates detailed reports that help assess the impact of code changes.
+The **Githru MCP Server** extends Claude’s capabilities through the **Model Context Protocol (MCP)** — enabling real-time access to Git analytics, PR insights, and repository visualization.
 
-#### Key Metrics:
+This MCP server is deployed on **[smithery.ai](https://smithery.ai)** and can be used directly from Claude’s MCP integration feature.
 
-- **Scale** – Total lines of code changed
-- **Dispersion** – Number and diversity of affected files
-- **Chaos** – Temporal instability in code changes
-- **Isolation** – Degree of dependency separation
-- **Lag** – Time delay between code changes
-- **Coupling** – Inter-module dependency level
-- **Long-tail Analysis** – Detects and highlights unusual file path patterns
+---
 
-### 🏆 Contributor Recommender
+## 🧩 Prerequisites
 
-Intelligently recommends the most relevant contributors for a given file, branch, or Pull Request area by analyzing recent contribution history and activity patterns.
+Before you begin, make sure you have:
 
-#### Recommendation Modes:
+- **Claude Desktop App** (with MCP support)  
+  👉 [Download here](https://claude.ai/download)
+- Access to the deployed **Githru MCP Server** on `smithery.ai`
 
-- PR-based recommendations
-- File/Directory path–based (supports glob patterns)
-- Branch-based analysis
-- Custom time range analysis
+---
 
-### 🧩 Author Work Pattern Analyzer
+## ⚙️ Setup in Claude
 
-Analyzes a specific author’s development activity over a given time range to quantify their workload and commit behavior patterns.
+1. **Find the JSON configuration**
+   - When you visit the [Githru MCP Server page on Smithery.ai](https://smithery.ai/server/@githru/githru-mcp-v1),  
+     click **“Connect → JSON”** to view the configuration details for our MCP server.
 
-It computes metrics such as commits, insertions, deletions, and churn, and classifies commits into types like feat, fix, or refactor to reveal the author’s primary focus areas.
-Optionally, it generates a visual HTML report with charts for intuitive insight into the author’s contribution trends.
+2. **Insert the Githru MCP configuration**
+   - Claude Desktop reads MCP server settings from the `claude_desktop_config.json` file.  
+     You need to modify the `args` path inside your local configuration file.
 
-#### Key Metrics:
+   **File locations:**
+   - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
+   - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
 
-- **Commits** – Total number of commits made by the author
-- **Insertions / Deletions** – Lines of code added and removed
-- **Churn (±)** – Overall code change volume (insertions + deletions)
-- **Commit Type Mix** – Distribution of commit purposes (e.g. feat, fix, refactor, docs, etc.)
-- **Branch & Period Context** – Analyzes activity within a specific branch and time range
+   ```json
+   {
+      "mcpServers": {
+        "githru-mcp-v1": {
+          "command": "npx",
+          "args": [
+            "-y",
+            "@smithery/cli@latest",
+            "run",
+            "@githru/githru-mcp-v1",
+            "--key",
+            "YOUR_API_KEY",
+            "--profile",
+            "PROFILE"
+          ],
+          "env": {
+            "GITHUB_TOKEN": "YOUR_GITHUB_TOKEN"
+          }
+        }
+      }
+    }
+   ```
+> 🧠 Tip: Replace the URL above with your actual Smithery MCP endpoint if it differs.
 
-## 🌐 Multilingual Support
+3. Save and reconnecting
+  - After saving, Claude will automatically connect to your Githru MCP instance.
+  - so reconnect Claude
 
-All tools support both **English** and **Korean** via the `locale` parameter (`en` or `ko`).
+---
 
-## 📈 Visualization Options
+## 🧠 About Model Context Protocol (MCP)
 
-- **Chart Mode**: Interactive HTML visualizations powered by **Chart.js**
+MCP is an open standard that lets Claude connect to external data and services safely and dynamically.
+Your Githru MCP Server acts as a “bridge” — providing contextual Git insights directly within the Claude chat interface.
 
-## 🚀 Use Cases
+For more on MCP:
+👉 (https://modelcontextprotocol.io)[https://modelcontextprotocol.io]
 
-- **Code Review Automation**: Analyze PR impact before merging
-- **Team Collaboration**: Identify the most relevant experts for code areas
-- **Development Insights**: Understand change patterns and dependency structures
+---
 
-## 📦 Integration
+## 📄 License
 
-Deploy remotely as an MCP server via **Smithery**, and connect directly with **Claude Desktop** for seamless integration with AI assistants.
+This project is licensed under the MIT License.
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions!
+If you’d like to improve the Githru MCP Server, please open a PR or file an issue on [GitHub](https://github.com/githru/githru-vscode-ext).