Skip to content

Commit d006e93

Browse files
committed
docs: update reules
1 parent 0261f2c commit d006e93

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

.ai/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,24 @@ AI tools can access external services (JIRA, Confluence, GitHub) via MCP configu
3535
```
3636

3737
4. **Verify your setup:**
38+
39+
**For Cursor users:**
40+
41+
- Restart Cursor to load the new MCP configuration
42+
- Ask the AI: "Can you list all available MCP tools and test them?"
43+
- The AI should be able to access JIRA, Confluence, GitHub, and other configured services
44+
45+
**For Augment users:**
46+
3847
```bash
39-
# For Augment users:
40-
auggie --mcp-config mcp.json "go over all my mcp tools and make sure they work as expected"
48+
npx @augmentcode/auggie --mcp-config mcp.json "go over all my mcp tools and make sure they work as expected"
4149
```
4250

51+
**For GitHub Copilot users:**
52+
53+
- Note: GitHub Copilot does not currently support MCP integration
54+
- MCP services (JIRA, Confluence, etc.) will not be available in Copilot
55+
4356
### Available MCP Services
4457

4558
The `mcp.json` file configures these services:
@@ -109,7 +122,7 @@ yarn test:cov # Run tests with coverage
109122
# Code Quality
110123
yarn lint # Lint all code
111124
yarn type-check:ui # TypeScript type checking
112-
yarn prettier:fix # Fix formatting
125+
yarn prettier:fix # Fix formatting on the changed files
113126
```
114127

115128
### Before Every Commit
@@ -137,7 +150,7 @@ yarn prettier:fix # Fix formatting
137150

138151
## Redis-Specific Context
139152

140-
- Support all Redis data types: String, Hash, List, Set, Sorted Set, Stream, JSON
153+
- Support all Redis data types: String, Hash, List, Set, Sorted Set, Vector Set, Stream, JSON
141154
- Handle Redis modules: RedisJSON, RediSearch, RedisTimeSeries, RedisGraph
142155
- Connection types: Standalone, Cluster, Sentinel
143156
- Features: Workbench, Data Browser, Profiler, SlowLog, Pub/Sub
@@ -158,7 +171,7 @@ When helping with RedisInsight development:
158171

159172
### DON'T:
160173

161-
- ❌ Use `console.log` (use proper logging)
174+
- ❌ Use `console.log`
162175
- ❌ Add unnecessary comments
163176
- ❌ Ignore linting errors
164177
- ❌ Skip tests

env.mcp.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# and create a classic token by pressing the first "Create Token" button
1212
#
1313
# 3. To verify your setup, run agent with the following command:
14-
# auggie --mcp-config mcp.json "go over all my mcp tools and make sure they work as expected"
14+
# npx @augmentcode/auggie --mcp-config mcp.json "go over all my mcp tools and make sure they work as expected"
1515
# or you can ask the agent UI to do the same
1616

1717
JIRA_API_TOKEN=<token>

0 commit comments

Comments
 (0)