Skip to content

Commit e956cec

Browse files
CSCSoftwareclaude
andcommitted
docs: update README — 29 tools, add Guidelines to overview, fix global_signatures parameter name
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 95cd60e commit e956cec

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ AiDex is an MCP server that gives AI coding assistants instant access to your en
1919

2020
</details>
2121

22-
### What's Inside — 28 Tools in One Server
22+
### What's Inside — 29 Tools in One Server
2323

2424
| Category | Tools | What it does |
2525
|----------|-------|--------------|
@@ -28,6 +28,7 @@ AiDex is an MCP server that gives AI coding assistants instant access to your en
2828
| **Project Overview** | `summary`, `tree`, `describe`, `files` | Entry points, language breakdown, file tree with stats, file listing by type |
2929
| **Cross-Project** | `link`, `unlink`, `links`, `scan` | Link dependencies, discover indexed projects |
3030
| **Global Search** | `global_init`, `global_query`, `global_signatures`, `global_status`, `global_refresh` | Search across ALL your projects at once — "Have I ever written X?" |
31+
| **Guidelines** | `global_guideline` | Persistent AI instructions & coding conventions — shared across all projects |
3132
| **Sessions** | `session`, `note` | Track sessions, detect external changes, leave notes for next session (with searchable history) |
3233
| **Task Backlog** | `task`, `tasks` | Built-in task management with priorities, tags, and auto-logged history |
3334
| **Screenshots** | `screenshot`, `windows` | Cross-platform screen capture with LLM optimization — scale + color reduction saves up to 95% tokens |
@@ -65,7 +66,7 @@ aidex_task({ path: ".", action: "create", title: "Fix edge case in parser", prio
6566

6667
## Table of Contents
6768

68-
- [What's Inside](#whats-inside--28-tools-in-one-server)
69+
- [What's Inside](#whats-inside--29-tools-in-one-server)
6970
- [The Problem](#the-problem)
7071
- [The Solution](#the-solution)
7172
- [Why Not Just Grep?](#why-not-just-grep)
@@ -79,6 +80,7 @@ aidex_task({ path: ".", action: "create", title: "Fix edge case in parser", prio
7980
- [Session Notes](#session-notes)
8081
- [Task Backlog](#task-backlog)
8182
- [Global Search](#global-search)
83+
- [AI Guidelines](#ai-guidelines)
8284
- [Screenshots — LLM-Optimized](#screenshots--llm-optimized)
8385
- [Interactive Viewer](#interactive-viewer)
8486
- [CLI Usage](#cli-usage)
@@ -299,7 +301,7 @@ Do I want to search code?
299301
- **`contains`**: Finds identifiers containing the term — `render` matches `preRenderSetup`
300302
- **`starts_with`**: Finds identifiers starting with the term — `Update` matches `UpdatePlayer`, `UpdateUI`
301303
302-
### All Tools (28)
304+
### All Tools (29)
303305
304306
| Category | Tools | Purpose |
305307
|----------|-------|---------|
@@ -512,8 +514,8 @@ With `index_unindexed: true`, it also auto-indexes all discovered projects with
512514
```
513515
aidex_global_query({ term: "TransparentWindow" }) # Exact match
514516
aidex_global_query({ term: "transparent", mode: "contains" }) # Fuzzy search
515-
aidex_global_signatures({ name: "Render", kind: "method" }) # Find methods
516-
aidex_global_signatures({ name: "Player", kind: "class" }) # Find classes
517+
aidex_global_signatures({ term: "Render", kind: "method" }) # Find methods
518+
aidex_global_signatures({ term: "Player", kind: "class" }) # Find classes
517519
```
518520

519521
### How it works

0 commit comments

Comments
 (0)