Skip to content

Commit e3b2c35

Browse files
authored
docs(readme): add new tools and alphabetize tool lists (#52)
Add startup_project_get, startup_project_set, debugger_evaluate, and debugger_set_variable to the README. Update debugger_launch descriptions to note optional project parameter. Alphabetize all tool tables.
1 parent 263e158 commit e3b2c35

1 file changed

Lines changed: 30 additions & 26 deletions

File tree

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -44,81 +44,85 @@
4444

4545
| Tool | Description |
4646
|------|-------------|
47+
| `project_info` | Get detailed project information |
48+
| `project_list` | List all projects in the solution |
49+
| `solution_close` | Close the current solution |
4750
| `solution_info` | Get information about the current solution |
4851
| `solution_open` | Open a solution file |
49-
| `solution_close` | Close the current solution |
50-
| `project_list` | List all projects in the solution |
51-
| `project_info` | Get detailed project information |
52+
| `startup_project_get` | Get the current startup project |
53+
| `startup_project_set` | Set the startup project for debugging |
5254

5355
### 📝 Document Tools
5456

5557
| Tool | Description |
5658
|------|-------------|
57-
| `document_list` | List all open documents |
5859
| `document_active` | Get the active document |
59-
| `document_open` | Open a file in the editor |
6060
| `document_close` | Close a document |
61+
| `document_list` | List all open documents |
62+
| `document_open` | Open a file in the editor |
6163
| `document_read` | Read document contents |
62-
| `document_write` | Write to a document |
6364
| `document_save` | Saves an open document |
65+
| `document_write` | Write to a document |
6466

6567
### ✏️ Editor Tools
6668

6769
| Tool | Description |
6870
|------|-------------|
69-
| `selection_get` | Get the current text selection |
70-
| `selection_set` | Set the selection range |
71+
| `editor_find` | Search within documents |
72+
| `editor_goto_line` | Navigate to a specific line |
7173
| `editor_insert` | Insert text at cursor position |
7274
| `editor_replace` | Find and replace text |
73-
| `editor_goto_line` | Navigate to a specific line |
74-
| `editor_find` | Search within documents |
75+
| `selection_get` | Get the current text selection |
76+
| `selection_set` | Set the selection range |
7577

7678
### 🔨 Build Tools
7779

7880
| Tool | Description |
7981
|------|-------------|
80-
| `build_solution` | Build the entire solution |
81-
| `build_project` | Build a specific project |
82-
| `clean_solution` | Clean the solution |
8382
| `build_cancel` | Cancel a running build |
83+
| `build_project` | Build a specific project |
84+
| `build_solution` | Build the entire solution |
8485
| `build_status` | Get current build status |
86+
| `clean_solution` | Clean the solution |
8587

8688
### 🧭 Navigation Tools
8789

8890
| Tool | Description |
8991
|------|-------------|
90-
| `goto_definition` | Navigate to the definition of a symbol |
9192
| `find_references` | Find all references to a symbol |
93+
| `goto_definition` | Navigate to the definition of a symbol |
9294
| `symbol_document` | Get all symbols defined in a document |
9395
| `symbol_workspace` | Search for symbols across the solution |
9496

9597
### 🐛 Debugger Tools
9698

9799
| Tool | Description |
98100
|------|-------------|
99-
| `debugger_status` | Get current debugger state |
100-
| `debugger_launch` | Start debugging (F5) |
101-
| `debugger_launch_without_debugging` | Start without debugger (Ctrl+F5) |
102-
| `debugger_continue` | Continue execution (F5) |
101+
| `debugger_add_breakpoint` | Add a breakpoint at a file and line |
103102
| `debugger_break` | Pause execution (Ctrl+Alt+Break) |
104-
| `debugger_stop` | Stop debugging (Shift+F5) |
105-
| `debugger_step_over` | Step over (F10) |
103+
| `debugger_continue` | Continue execution (F5) |
104+
| `debugger_evaluate` | Evaluate an expression in the current debug context |
105+
| `debugger_get_callstack` | Get the call stack |
106+
| `debugger_get_locals` | Get local variables in current frame |
107+
| `debugger_launch` | Start debugging (F5), optionally for a specific project |
108+
| `debugger_launch_without_debugging` | Start without debugger (Ctrl+F5), optionally for a specific project |
109+
| `debugger_list_breakpoints` | List all breakpoints |
110+
| `debugger_remove_breakpoint` | Remove a breakpoint |
111+
| `debugger_set_variable` | Set the value of a local variable |
112+
| `debugger_status` | Get current debugger state |
106113
| `debugger_step_into` | Step into (F11) |
107114
| `debugger_step_out` | Step out (Shift+F11) |
108-
| `debugger_add_breakpoint` | Add a breakpoint at a file and line |
109-
| `debugger_remove_breakpoint` | Remove a breakpoint |
110-
| `debugger_list_breakpoints` | List all breakpoints |
111-
| `debugger_get_locals` | Get local variables in current frame |
112-
| `debugger_get_callstack` | Get the call stack |
115+
| `debugger_step_over` | Step over (F10) |
116+
| `debugger_stop` | Stop debugging (Shift+F5) |
113117

114118
### 🔍 Diagnostics Tools
115119

116120
| Tool | Description |
117121
|------|-------------|
118122
| `errors_list` | Read build errors, warnings, and messages from the Error List |
123+
| `output_list_panes` | List all available Output window panes |
119124
| `output_read` | Read content from an Output window pane |
120125
| `output_write` | Write a message to an Output window pane |
121-
| `output_list_panes` | List all available Output window panes |
122126

123127
## 🛠️ Installation
124128

0 commit comments

Comments
 (0)