ai-readme-mcp 0.4.3 → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -2
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -6,11 +6,25 @@
|
|
|
6
6
|
[](https://www.typescriptlang.org/)
|
|
7
7
|
[](https://nodejs.org/)
|
|
8
8
|
|
|
9
|
+
## 📑 Quick Navigation
|
|
10
|
+
|
|
11
|
+
- [Installation & Setup](#-installation--setup)
|
|
12
|
+
- [For Claude Code](#for-claude-code-vscode-extension)
|
|
13
|
+
- [For Cursor](#for-cursor)
|
|
14
|
+
- [For GitHub Copilot](#for-github-copilot-vscode-1102)
|
|
15
|
+
- [For Claude Desktop](#for-claude-desktop-application)
|
|
16
|
+
- [Alternative Installation Methods](#alternative-installation-methods)
|
|
17
|
+
- [Create Your First AI_README](#create-your-first-ai_readme)
|
|
18
|
+
- [Multi-Level AI_README](#multi-level-ai_readme-not-just-for-monorepos)
|
|
19
|
+
- [Available MCP Tools](#️-available-mcp-tools)
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
9
23
|
## 📋 Overview
|
|
10
24
|
|
|
11
25
|
**AI_README MCP Server** is a Model Context Protocol (MCP) server that helps AI assistants understand your project conventions through dedicated `AI_README.md` guide files. It automatically discovers, routes, and manages these files so AI can generate consistent, high-quality code that matches your team's standards.
|
|
12
26
|
|
|
13
|
-
**Works with:**
|
|
27
|
+
**Works with:** GitHub Copilot (VSCode 1.102+), Claude Code, Cursor, and other MCP-compatible AI tools.
|
|
14
28
|
|
|
15
29
|
---
|
|
16
30
|
|
|
@@ -78,7 +92,7 @@ This MCP (Model Context Protocol) server automates the entire workflow:
|
|
|
78
92
|
In your project directory, run:
|
|
79
93
|
|
|
80
94
|
```bash
|
|
81
|
-
claude mcp add --scope project ai-readme-manager npx -- ai-readme-mcp
|
|
95
|
+
claude mcp add --scope project ai-readme-manager npx -- -y ai-readme-mcp
|
|
82
96
|
```
|
|
83
97
|
|
|
84
98
|
This creates a `.mcp.json` file that uses `npx` to run the package - no installation or path configuration needed!
|
|
@@ -143,6 +157,36 @@ Add to Cursor's MCP configuration file:
|
|
|
143
157
|
|
|
144
158
|
After configuring, restart Cursor completely.
|
|
145
159
|
|
|
160
|
+
### For GitHub Copilot (VSCode 1.102+)
|
|
161
|
+
|
|
162
|
+
**Requirements:**
|
|
163
|
+
- VSCode 1.102 or later
|
|
164
|
+
- GitHub Copilot & Copilot Chat extensions installed
|
|
165
|
+
|
|
166
|
+
**Option 1: Using VSCode Settings UI**
|
|
167
|
+
|
|
168
|
+
1. Open VSCode Settings (Ctrl+,)
|
|
169
|
+
2. Search for "MCP"
|
|
170
|
+
3. Click "Edit in settings.json"
|
|
171
|
+
4. Add the MCP server configuration
|
|
172
|
+
|
|
173
|
+
**Option 2: Manual Configuration**
|
|
174
|
+
|
|
175
|
+
Add to your VSCode `settings.json`:
|
|
176
|
+
|
|
177
|
+
```json
|
|
178
|
+
{
|
|
179
|
+
"github.copilot.chat.mcp.servers": {
|
|
180
|
+
"ai-readme-manager": {
|
|
181
|
+
"command": "npx",
|
|
182
|
+
"args": ["-y", "ai-readme-mcp"]
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
After configuring, restart VSCode and you'll see the MCP tools available in GitHub Copilot Chat!
|
|
189
|
+
|
|
146
190
|
### For Claude Desktop Application
|
|
147
191
|
|
|
148
192
|
Add to `claude_desktop_config.json`:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-readme-mcp",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.5",
|
|
4
4
|
"description": "MCP server for managing AI_README.md files in projects",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -45,8 +45,12 @@
|
|
|
45
45
|
"readme",
|
|
46
46
|
"context",
|
|
47
47
|
"claude",
|
|
48
|
+
"copilot",
|
|
49
|
+
"github-copilot",
|
|
50
|
+
"cursor",
|
|
48
51
|
"llm",
|
|
49
|
-
"model-context-protocol"
|
|
52
|
+
"model-context-protocol",
|
|
53
|
+
"vscode"
|
|
50
54
|
],
|
|
51
55
|
"author": "Draco Cheng <draco.cheng@outlook.com>",
|
|
52
56
|
"license": "MIT",
|