|
4 | 4 | <strong>A powerful Model Context Protocol (MCP) server that provides advanced Git repository analysis and visualization tools designed to enhance team collaboration.</strong> |
5 | 5 | </p> |
6 | 6 |
|
7 | | -## 🎯 Core Features |
| 7 | +--- |
8 | 8 |
|
9 | | -### 📊 Feature Impact Analyzer |
| 9 | +## 🚀 Overview |
10 | 10 |
|
11 | | -Analyzes GitHub Pull Requests to compute comprehensive impact metrics such as **scale, dispersion, chaos, isolation, lag, and coupling**. |
12 | | -It features **long-tail–based analysis** to identify outlier file paths and generates detailed reports that help assess the impact of code changes. |
| 11 | +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. |
13 | 12 |
|
14 | | -#### Key Metrics: |
| 13 | +This MCP server is deployed on **[smithery.ai](https://smithery.ai)** and can be used directly from Claude’s MCP integration feature. |
15 | 14 |
|
16 | | -- **Scale** – Total lines of code changed |
17 | | -- **Dispersion** – Number and diversity of affected files |
18 | | -- **Chaos** – Temporal instability in code changes |
19 | | -- **Isolation** – Degree of dependency separation |
20 | | -- **Lag** – Time delay between code changes |
21 | | -- **Coupling** – Inter-module dependency level |
22 | | -- **Long-tail Analysis** – Detects and highlights unusual file path patterns |
| 15 | +--- |
23 | 16 |
|
24 | | -### 🏆 Contributor Recommender |
| 17 | +## 🧩 Prerequisites |
25 | 18 |
|
26 | | -Intelligently recommends the most relevant contributors for a given file, branch, or Pull Request area by analyzing recent contribution history and activity patterns. |
| 19 | +Before you begin, make sure you have: |
27 | 20 |
|
28 | | -#### Recommendation Modes: |
| 21 | +- **Claude Desktop App** (with MCP support) |
| 22 | + 👉 [Download here](https://claude.ai/download) |
| 23 | +- Access to the deployed **Githru MCP Server** on `smithery.ai` |
29 | 24 |
|
30 | | -- PR-based recommendations |
31 | | -- File/Directory path–based (supports glob patterns) |
32 | | -- Branch-based analysis |
33 | | -- Custom time range analysis |
| 25 | +--- |
34 | 26 |
|
35 | | -### 🧩 Author Work Pattern Analyzer |
| 27 | +## ⚙️ Setup in Claude |
36 | 28 |
|
37 | | -Analyzes a specific author’s development activity over a given time range to quantify their workload and commit behavior patterns. |
| 29 | +1. **Find the JSON configuration** |
| 30 | + - When you visit the [Githru MCP Server page on Smithery.ai](https://smithery.ai/server/@githru/githru-mcp-v1), |
| 31 | + click **“Connect → JSON”** to view the configuration details for our MCP server. |
38 | 32 |
|
39 | | -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. |
40 | | -Optionally, it generates a visual HTML report with charts for intuitive insight into the author’s contribution trends. |
| 33 | +2. **Insert the Githru MCP configuration** |
| 34 | + - Claude Desktop reads MCP server settings from the `claude_desktop_config.json` file. |
| 35 | + You need to modify the `args` path inside your local configuration file. |
41 | 36 |
|
42 | | -#### Key Metrics: |
| 37 | + **File locations:** |
| 38 | + - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json` |
| 39 | + - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json` |
43 | 40 |
|
44 | | -- **Commits** – Total number of commits made by the author |
45 | | -- **Insertions / Deletions** – Lines of code added and removed |
46 | | -- **Churn (±)** – Overall code change volume (insertions + deletions) |
47 | | -- **Commit Type Mix** – Distribution of commit purposes (e.g. feat, fix, refactor, docs, etc.) |
48 | | -- **Branch & Period Context** – Analyzes activity within a specific branch and time range |
| 41 | + ```json |
| 42 | + { |
| 43 | + "mcpServers": { |
| 44 | + "githru-mcp-v1": { |
| 45 | + "command": "npx", |
| 46 | + "args": [ |
| 47 | + "-y", |
| 48 | + "@smithery/cli@latest", |
| 49 | + "run", |
| 50 | + "@githru/githru-mcp-v1", |
| 51 | + "--key", |
| 52 | + "YOUR_API_KEY", |
| 53 | + "--profile", |
| 54 | + "PROFILE" |
| 55 | + ], |
| 56 | + "env": { |
| 57 | + "GITHUB_TOKEN": "YOUR_GITHUB_TOKEN" |
| 58 | + } |
| 59 | + } |
| 60 | + } |
| 61 | + } |
| 62 | + ``` |
| 63 | +> 🧠 Tip: Replace the URL above with your actual Smithery MCP endpoint if it differs. |
49 | 64 |
|
50 | | -## 🌐 Multilingual Support |
| 65 | +3. Save and reconnecting |
| 66 | + - After saving, Claude will automatically connect to your Githru MCP instance. |
| 67 | + - so reconnect Claude |
51 | 68 |
|
52 | | -All tools support both **English** and **Korean** via the `locale` parameter (`en` or `ko`). |
| 69 | +--- |
53 | 70 |
|
54 | | -## 📈 Visualization Options |
| 71 | +## 🧠 About Model Context Protocol (MCP) |
55 | 72 |
|
56 | | -- **Chart Mode**: Interactive HTML visualizations powered by **Chart.js** |
| 73 | +MCP is an open standard that lets Claude connect to external data and services safely and dynamically. |
| 74 | +Your Githru MCP Server acts as a “bridge” — providing contextual Git insights directly within the Claude chat interface. |
57 | 75 |
|
58 | | -## 🚀 Use Cases |
| 76 | +For more on MCP: |
| 77 | +👉 (https://modelcontextprotocol.io)[https://modelcontextprotocol.io] |
59 | 78 |
|
60 | | -- **Code Review Automation**: Analyze PR impact before merging |
61 | | -- **Team Collaboration**: Identify the most relevant experts for code areas |
62 | | -- **Development Insights**: Understand change patterns and dependency structures |
| 79 | +--- |
63 | 80 |
|
64 | | -## 📦 Integration |
| 81 | +## 📄 License |
65 | 82 |
|
66 | | -Deploy remotely as an MCP server via **Smithery**, and connect directly with **Claude Desktop** for seamless integration with AI assistants. |
| 83 | +This project is licensed under the MIT License. |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +## 🤝 Contributing |
| 88 | + |
| 89 | +We welcome contributions! |
| 90 | +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). |
0 commit comments