Skip to content

Commit 73fb5d9

Browse files
committed
docs: update all tool descriptions in README, llms.txt, llms-full.txt
Synchronized tool descriptions across all documentation: - README.md: Available Tools table - llms.txt: 9 MCP Tools list - llms-full.txt: 3 tool lists updated Key improvements: - search_code: "Use FIRST", Go/PHP/Python support - hybrid_search: "EXACT matches" emphasis - get_function_details: "COMPLETE" code - find_implementations: "use before refactoring" - search_docs: "Not for code" clarification - index_workspace: "Usually automatic"
1 parent 0fdbab3 commit 73fb5d9

File tree

2 files changed

+44
-35
lines changed

2 files changed

+44
-35
lines changed

llms-full.txt

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@ Without RagCode, AI assistants must:
112112

113113
### 🔧 9 Powerful MCP Tools for AI Code Assistants
114114

115-
1. **`search_code`** - Semantic vector search across your entire codebase
116-
2. **`hybrid_search`** - Combined semantic + keyword search for maximum accuracy
117-
3. **`get_function_details`** - Complete function signatures, parameters, and implementation
118-
4. **`find_type_definition`** - Locate class, struct, and interface definitions instantly
119-
5. **`find_implementations`** - Discover all usages and implementations of any symbol
120-
6. **`list_package_exports`** - Browse all exported symbols from any package/module
121-
7. **`search_docs`** - Semantic search through project documentation (Markdown)
122-
8. **`get_code_context`** - Extract code snippets with surrounding context
123-
9. **`index_workspace`** - Automated workspace indexing with language detection
115+
1. **`search_code`** - **Use FIRST** - Semantic search, returns complete code with file/line. Go, PHP, Python.
116+
2. **`hybrid_search`** - Keyword + semantic for **EXACT matches** (variable names, errors) + context
117+
3. **`get_function_details`** - **COMPLETE** function code with signature, params, return types, body
118+
4. **`find_type_definition`** - Class/struct/interface with all fields, methods, inheritance chain
119+
5. **`find_implementations`** - All callers/usages - **use before refactoring** to understand impact
120+
6. **`list_package_exports`** - List public symbols in package/module. Go, PHP, Python.
121+
7. **`search_docs`** - Search Markdown docs (README, guides). **Not for code.**
122+
8. **`get_code_context`** - Read file lines with context (use with file path + line numbers)
123+
9. **`index_workspace`** - Reindex codebase. **Usually automatic.**
124124

125125
### 🌐 Multi-Language Code Intelligence
126126

@@ -376,15 +376,15 @@ Edit `~/.config/Code/User/globalStorage/mcp-servers.json`:
376376
See [QUICKSTART.md](./QUICKSTART.md) for detailed VS Code setup and troubleshooting.
377377

378378
### Available Tools
379-
1. **`search_code`** – semantic code search
380-
2. **`hybrid_search`** – semantic + lexical search
381-
3. **`get_function_details`** – detailed information about a function or method
382-
4. **`find_type_definition`** – locate struct, interface, or type definitions
383-
5. **`find_implementations`** – find implementations or usages of a symbol
384-
6. **`list_package_exports`** – list all exported symbols in a package
385-
7. **`search_docs`** – search markdown documentation
386-
8. **`index_workspace`** – manually trigger indexing of a workspace (usually not needed)
387-
9. **`get_code_context`** – read code from specific file locations with context
379+
1. **`search_code`** – **Use FIRST** – semantic search, returns complete code. Go, PHP, Python.
380+
2. **`hybrid_search`** – keyword + semantic for **EXACT matches** + context
381+
3. **`get_function_details`** – **COMPLETE** function code with signature, params, body
382+
4. **`find_type_definition`** – class/struct/interface with fields, methods, inheritance
383+
5. **`find_implementations`** – all callers/usages – **use before refactoring**
384+
6. **`list_package_exports`** – list public symbols. Go, PHP, Python.
385+
7. **`search_docs`** – search Markdown docs. **Not for code.**
386+
8. **`get_code_context`** – read file lines with context (file path + line numbers)
387+
9. **`index_workspace`** – reindex codebase. **Usually automatic.**
388388

389389
**All tools require a `file_path` parameter** so that RagCode can determine the correct workspace.
390390

@@ -888,63 +888,72 @@ You can also explicitly reference RagCode tools using the `#` symbol:
888888

889889
#### Available Tools:
890890

891-
1. **`search_code`** - Semantic code search
891+
1. **`search_code`** - **Use FIRST** - Semantic search, returns complete code. Go, PHP, Python.
892892
```json
893893
{
894894
"query": "authentication middleware",
895895
"file_path": "/path/to/your/project/file.go"
896896
}
897897
```
898898

899-
2. **`hybrid_search`** - Hybrid search (semantic + lexical)
899+
2. **`hybrid_search`** - Keyword + semantic for **EXACT matches** + context
900900
```json
901901
{
902902
"query": "user login function",
903903
"file_path": "/path/to/your/project/file.php"
904904
}
905905
```
906906

907-
3. **`get_function_details`** - Complete details about a function
907+
3. **`get_function_details`** - **COMPLETE** function code with signature, params, body
908908
```json
909909
{
910910
"function_name": "HandleLogin",
911911
"file_path": "/path/to/your/project/auth.go"
912912
}
913913
```
914914

915-
4. **`find_type_definition`** - Find type/class definition
915+
4. **`find_type_definition`** - Class/struct/interface with fields, methods, inheritance
916916
```json
917917
{
918918
"type_name": "User",
919919
"file_path": "/path/to/your/project/models/user.php"
920920
}
921921
```
922922

923-
5. **`find_implementations`** - Find where a function is used
923+
5. **`find_implementations`** - All callers/usages - **use before refactoring**
924924
```json
925925
{
926926
"symbol_name": "ProcessPayment",
927927
"file_path": "/path/to/your/project/payment.go"
928928
}
929929
```
930930

931-
6. **`list_package_exports`** - List all exports of a package
931+
6. **`list_package_exports`** - List public symbols. Go, PHP, Python.
932932
```json
933933
{
934934
"package": "github.com/myapp/auth",
935935
"file_path": "/path/to/your/project/auth/handler.go"
936936
}
937937
```
938938

939-
7. **`search_docs`** - Search in documentation (Markdown)
939+
7. **`search_docs`** - Search Markdown docs. **Not for code.**
940940
```json
941941
{
942942
"query": "API authentication",
943943
"file_path": "/path/to/your/project/README.md"
944944
}
945945
```
946946

947-
8. **`index_workspace`** - Manually index a workspace
947+
8. **`get_code_context`** - Read file lines with context (file path + line numbers)
948+
```json
949+
{
950+
"file_path": "/path/to/your/project/auth.go",
951+
"start_line": 45,
952+
"end_line": 60
953+
}
954+
```
955+
956+
9. **`index_workspace`** - Reindex codebase. **Usually automatic.**
948957
```json
949958
{
950959
"file_path": "/path/to/your/project/main.go"

llms.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,15 @@ User: "Find authentication middleware in this codebase"
6363

6464
## 9 MCP Tools
6565

66-
1. `search_code` - Semantic search across the codebase
67-
2. `hybrid_search` - Combined semantic + lexical search
68-
3. `get_function_details` - Get function signature and body
69-
4. `find_type_definition` - Find struct/interface definitions
70-
5. `find_implementations` - Find usages of a symbol
71-
6. `list_package_exports` - List exported symbols from a package
72-
7. `search_docs` - Search markdown documentation
73-
8. `get_code_context` - Read code with surrounding context
74-
9. `index_workspace` - Manual indexing (usually automatic)
66+
1. `search_code` - **Use FIRST** - Semantic search, returns complete code with file/line. Go, PHP, Python.
67+
2. `hybrid_search` - Keyword + semantic for **EXACT matches** (variable names, errors) + context
68+
3. `get_function_details` - **COMPLETE** function code with signature, params, body
69+
4. `find_type_definition` - Class/struct/interface with all fields, methods, inheritance
70+
5. `find_implementations` - All callers/usages - **use before refactoring**
71+
6. `list_package_exports` - List public symbols in package. Go, PHP, Python.
72+
7. `search_docs` - Search Markdown docs (README, guides). **Not for code.**
73+
8. `get_code_context` - Read file lines with context (use with file path + line numbers)
74+
9. `index_workspace` - Reindex codebase. **Usually automatic.**
7575

7676
## Configuration
7777

0 commit comments

Comments
 (0)