Changes in c9b7dfafc4

Jonathan Miller — docs: organize wiki into guides/ and reference/ folders
2026-06-19 07:26:10 +00:00

New page created

1		-
	1	+ [← Back to Home](Home)
	2	+
	3	+ # API
	4	+
	5	+ Complete MCP tool reference for mcp-windows. All 44 tools with parameters.
	6	+
	7	+ ---
	8	+
	9	+ ## Terminal & Process Execution
	10	+
	11	+ ### windows_execute
	12	+
	13	+ Execute a shell command (PowerShell, cmd, or bash).
	14	+
	15	+ | Parameter | Type | Default | Description |
	16	+ |-----------|------|---------|-------------|
	17	+ | `command` | string | *required* | The command to execute |
	18	+ | `shell` | `pwsh` \| `cmd` \| `bash` | `pwsh` | Shell to use |
	19	+ | `timeout` | number | 30000 | Timeout in milliseconds |
	20	+ | `cwd` | string | -- | Working directory |
	21	+
	22	+ ### windows_process_list
	23	+
	24	+ List running processes.
	25	+
	26	+ | Parameter | Type | Default | Description |
	27	+ |-----------|------|---------|-------------|
	28	+ | `filter` | string | -- | Filter by process name (substring) |
	29	+ | `sort` | `cpu` \| `memory` \| `name` | `memory` | Sort order |
	30	+ | `limit` | number | 50 | Max results |
	31	+
	32	+ ### windows_process_kill
	33	+
	34	+ Terminate processes by PID or name.
	35	+
	36	+ | Parameter | Type | Default | Description |
	37	+ |-----------|------|---------|-------------|
	38	+ | `pid` | number | -- | Process ID to kill |
	39	+ | `name` | string | -- | Process name to kill (all matching) |
	40	+ | `force` | boolean | false | Force termination |
	41	+
	42	+ ### windows_terminal_start
	43	+
	44	+ Start a persistent interactive terminal session.
	45	+
	46	+ | Parameter | Type | Default | Description |
	47	+ |-----------|------|---------|-------------|
	48	+ | `shell` | `pwsh` \| `cmd` \| `bash` \| `python` \| `node` \| `wsl` | `pwsh` | Shell type |
	49	+
	50	+ ### windows_terminal_send
	51	+
	52	+ Send input to a running terminal session.
	53	+
	54	+ | Parameter | Type | Description |
	55	+ |-----------|------|-------------|
	56	+ | `pid` | number | Session PID |
	57	+ | `input` | string | Text to send |
	58	+
	59	+ ### windows_terminal_read
	60	+
	61	+ Read output from a terminal session with pagination.
	62	+
	63	+ | Parameter | Type | Default | Description |
	64	+ |-----------|------|---------|-------------|
	65	+ | `pid` | number | *required* | Session PID |
	66	+ | `offset` | number | 0 | Line offset (negative = from end) |
	67	+ | `length` | number | -- | Number of lines |
	68	+
	69	+ ### windows_terminal_list
	70	+
	71	+ List all active terminal sessions. No parameters.
	72	+
	73	+ ### windows_terminal_kill
	74	+
	75	+ Terminate a terminal session.
	76	+
	77	+ | Parameter | Type | Description |
	78	+ |-----------|------|-------------|
	79	+ | `pid` | number | Session PID to terminate |
	80	+
	81	+ ---
	82	+
	83	+ ## Audio & Volume
	84	+
	85	+ ### windows_audio_get
	86	+
	87	+ Get current audio state. No parameters.
	88	+
	89	+ Returns: volume (0-100), mute state, default device name.
	90	+
	91	+ ### windows_audio_set
	92	+
	93	+ Set audio volume or mute state.
	94	+
	95	+ | Parameter | Type | Description |
	96	+ |-----------|------|-------------|
	97	+ | `volume` | number (0-100) | Volume level |
	98	+ | `mute` | `true` \| `false` \| `toggle` | Mute state |
	99	+
	100	+ ### windows_audio_app_volumes
	101	+
	102	+ List per-application audio sessions. Without parameters, lists all apps. Set `app` + `volume`/`mute` to modify.
	103	+
	104	+ | Parameter | Type | Description |
	105	+ |-----------|------|-------------|
	106	+ | `app` | string | App name to target |
	107	+ | `volume` | number (0-100) | Volume to set |
	108	+ | `mute` | `true` \| `false` \| `toggle` | Mute state |
	109	+
	110	+ ---
	111	+
	112	+ ## System Information
	113	+
	114	+ ### windows_system_info
	115	+
	116	+ Get comprehensive system information. No parameters.
	117	+
	118	+ Returns: OS, CPU, RAM, disk, network adapters, uptime.
	119	+
	120	+ ### windows_installed_apps
	121	+
	122	+ List installed applications.
	123	+
	124	+ | Parameter | Type | Default | Description |
	125	+ |-----------|------|---------|-------------|
	126	+ | `filter` | string | -- | Filter by name |
	127	+ | `sort` | `name` \| `date` \| `size` | `name` | Sort order |
	128	+ | `limit` | number | 50 | Max results |
	129	+
	130	+ ---
	131	+
	132	+ ## File System
	133	+
	134	+ ### windows_file_read
	135	+
	136	+ Read a file with line pagination.
	137	+
	138	+ | Parameter | Type | Default | Description |
	139	+ |-----------|------|---------|-------------|
	140	+ | `path` | string | *required* | Absolute file path |
	141	+ | `offset` | number | 0 | Line offset (negative = tail) |
	142	+ | `length` | number | 200 | Lines to return |
	143	+
	144	+ ### windows_file_write
	145	+
	146	+ Write or append to a file.
	147	+
	148	+ | Parameter | Type | Default | Description |
	149	+ |-----------|------|---------|-------------|
	150	+ | `path` | string | *required* | Absolute file path |
	151	+ | `content` | string | *required* | Content to write |
	152	+ | `mode` | `write` \| `append` | `write` | Write mode |
	153	+
	154	+ ### windows_file_edit
	155	+
	156	+ Surgical find/replace.
	157	+
	158	+ | Parameter | Type | Default | Description |
	159	+ |-----------|------|---------|-------------|
	160	+ | `path` | string | *required* | Absolute file path |
	161	+ | `old_string` | string | *required* | Text to find |
	162	+ | `new_string` | string | *required* | Replacement text |
	163	+ | `expected_count` | number | -- | Fail if count mismatches |
	164	+ | `replace_all` | boolean | false | Replace all occurrences |
	165	+
	166	+ ### windows_search
	167	+
	168	+ Search files by name or content.
	169	+
	170	+ | Parameter | Type | Default | Description |
	171	+ |-----------|------|---------|-------------|
	172	+ | `type` | `files` \| `content` | *required* | Search type |
	173	+ | `pattern` | string | *required* | Glob or regex pattern |
	174	+ | `path` | string | `.` | Directory to search |
	175	+ | `case_sensitive` | boolean | false | Case-sensitive |
	176	+ | `file_pattern` | string | -- | Filter files (content search) |
	177	+ | `context_lines` | number | 0 | Context around matches |
	178	+ | `limit` | number | 50 | Max results |
	179	+
	180	+ ### windows_file_search
	181	+
	182	+ Search files using PowerShell.
	183	+
	184	+ | Parameter | Type | Default | Description |
	185	+ |-----------|------|---------|-------------|
	186	+ | `query` | string | *required* | Search query |
	187	+ | `path` | string | `C:\` | Directory to search |
	188	+ | `type` | `name` \| `content` | `name` | Search type |
	189	+ | `extension` | string | -- | File extension filter |
	190	+ | `limit` | number | 30 | Max results |
	191	+
	192	+ ### windows_drives
	193	+
	194	+ List all drives/volumes. No parameters.
	195	+
	196	+ ### windows_recycle_bin
	197	+
	198	+ Manage the Recycle Bin.
	199	+
	200	+ | Parameter | Type | Default | Description |
	201	+ |-----------|------|---------|-------------|
	202	+ | `action` | `list` \| `size` \| `empty` \| `restore` | `list` | Action |
	203	+ | `filter` | string | -- | Filter by filename |
	204	+ | `limit` | number | 30 | Max items (list) |
	205	+
	206	+ ---
	207	+
	208	+ ## Services
	209	+
	210	+ ### windows_service_list
	211	+
	212	+ | Parameter | Type | Default | Description |
	213	+ |-----------|------|---------|-------------|
	214	+ | `filter` | string | -- | Filter by name (substring) |
	215	+ | `status` | `running` \| `stopped` \| `all` | `all` | Status filter |
	216	+
	217	+ ### windows_service_control
	218	+
	219	+ | Parameter | Type | Description |
	220	+ |-----------|------|-------------|
	221	+ | `name` | string | Service name |
	222	+ | `action` | `start` \| `stop` \| `restart` \| `enable` \| `disable` | Action |
	223	+
	224	+ ---
	225	+
	226	+ ## Power Management
	227	+
	228	+ ### windows_power_get
	229	+
	230	+ Get power state. No parameters.
	231	+
	232	+ ### windows_power_action
	233	+
	234	+ | Parameter | Type | Description |
	235	+ |-----------|------|-------------|
	236	+ | `action` | `sleep` \| `hibernate` \| `lock` \| `shutdown` \| `restart` \| `logoff` \| `plan` | Action |
	237	+ | `delay` | number | Delay in seconds |
	238	+ | `cancel` | boolean | Cancel scheduled shutdown |
	239	+ | `plan` | `balanced` \| `performance` \| `powersaver` | Power plan (with action=plan) |
	240	+
	241	+ ---
	242	+
	243	+ ## Network
	244	+
	245	+ ### windows_network_info
	246	+
	247	+ Get network configuration. No parameters.
	248	+
	249	+ ### windows_network_connections
	250	+
	251	+ | Parameter | Type | Default | Description |
	252	+ |-----------|------|---------|-------------|
	253	+ | `state` | `all` \| `listen` \| `established` \| `time_wait` \| `close_wait` | `all` | State filter |
	254	+ | `port` | number | -- | Port filter |
	255	+ | `process_name` | string | -- | Process name filter |
	256	+ | `limit` | number | 50 | Max results |
	257	+
	258	+ ---
	259	+
	260	+ ## Display & Screenshot
	261	+
	262	+ ### windows_display_get
	263	+
	264	+ Get display configuration. No parameters.
	265	+
	266	+ ### windows_display_set
	267	+
	268	+ | Parameter | Type | Description |
	269	+ |-----------|------|-------------|
	270	+ | `resolution` | string | Resolution as `WIDTHxHEIGHT` |
	271	+ | `brightness` | number (0-100) | Screen brightness (laptops) |
	272	+
	273	+ ### windows_screenshot
	274	+
	275	+ | Parameter | Type | Default | Description |
	276	+ |-----------|------|---------|-------------|
	277	+ | `target` | `screen` \| `window` \| `region` | `screen` | Capture target |
	278	+ | `monitor` | number | 0 | Monitor index |
	279	+ | `window_title` | string | -- | Window title (for window) |
	280	+ | `x`, `y`, `width`, `height` | number | -- | Region bounds |
	281	+ | `save_path` | string | -- | Save to file instead of base64 |
	282	+
	283	+ ---
	284	+
	285	+ ## Window Management
	286	+
	287	+ ### windows_window_list
	288	+
	289	+ | Parameter | Type | Description |
	290	+ |-----------|------|-------------|
	291	+ | `filter` | string | Filter by title (substring) |
	292	+
	293	+ ### windows_window_control
	294	+
	295	+ | Parameter | Type | Description |
	296	+ |-----------|------|-------------|
	297	+ | `title` | string | Window title (substring) |
	298	+ | `pid` | number | Process ID |
	299	+ | `action` | `minimize` \| `maximize` \| `restore` \| `close` \| `focus` \| `move` \| `resize` \| `topmost` | Action |
	300	+ | `x`, `y` | number | Position (for move) |
	301	+ | `width`, `height` | number | Size (for resize) |
	302	+ | `topmost` | boolean | Always-on-top state |
	303	+
	304	+ ---
	305	+
	306	+ ## Clipboard
	307	+
	308	+ ### windows_clipboard_get
	309	+
	310	+ Read clipboard contents. No parameters.
	311	+
	312	+ ### windows_clipboard_set
	313	+
	314	+ | Parameter | Type | Description |
	315	+ |-----------|------|-------------|
	316	+ | `text` | string | Text to copy |
	317	+ | `files` | string[] | File paths to copy |
	318	+ | `clear` | boolean | Clear clipboard |
	319	+
	320	+ ---
	321	+
	322	+ ## Notifications
	323	+
	324	+ ### windows_notification_send
	325	+
	326	+ | Parameter | Type | Default | Description |
	327	+ |-----------|------|---------|-------------|
	328	+ | `title` | string | *required* | Title |
	329	+ | `body` | string | *required* | Body text |
	330	+ | `icon` | string | -- | Icon file path |
	331	+ | `sound` | boolean | true | Play sound |
	332	+
	333	+ ---
	334	+
	335	+ ## Registry
	336	+
	337	+ ### windows_registry_read
	338	+
	339	+ | Parameter | Type | Default | Description |
	340	+ |-----------|------|---------|-------------|
	341	+ | `path` | string | *required* | Registry path (HKCU:\, HKLM:\, etc.) |
	342	+ | `value` | string | -- | Specific value name |
	343	+ | `subkeys` | boolean | false | List subkeys instead |
	344	+
	345	+ ### windows_registry_write
	346	+
	347	+ | Parameter | Type | Default | Description |
	348	+ |-----------|------|---------|-------------|
	349	+ | `path` | string | *required* | Registry path |
	350	+ | `name` | string | *required* | Value name |
	351	+ | `value` | string | *required* | Value data |
	352	+ | `type` | `String` \| `DWord` \| `QWord` \| `Binary` \| `ExpandString` \| `MultiString` | `String` | Value type |
	353	+ | `hklm_override` | boolean | false | Allow HKLM writes |
	354	+ | `action` | `set` \| `delete` \| `create_key` \| `delete_key` | `set` | Action |
	355	+
	356	+ ---
	357	+
	358	+ ## Environment Variables
	359	+
	360	+ ### windows_env_get
	361	+
	362	+ | Parameter | Type | Default | Description |
	363	+ |-----------|------|---------|-------------|
	364	+ | `name` | string | -- | Variable name (omit to list all) |
	365	+ | `scope` | `user` \| `system` \| `both` | `both` | Scope |
	366	+
	367	+ ### windows_env_set
	368	+
	369	+ | Parameter | Type | Default | Description |
	370	+ |-----------|------|---------|-------------|
	371	+ | `name` | string | *required* | Variable name |
	372	+ | `value` | string | -- | Value |
	373	+ | `scope` | `user` \| `system` | `user` | Scope |
	374	+ | `action` | `set` \| `remove` \| `append_path` \| `prepend_path` | `set` | Action |
	375	+
	376	+ ---
	377	+
	378	+ ## Startup Items
	379	+
	380	+ ### windows_startup_list
	381	+
	382	+ List all startup items. No parameters.
	383	+
	384	+ ### windows_startup_manage
	385	+
	386	+ | Parameter | Type | Default | Description |
	387	+ |-----------|------|---------|-------------|
	388	+ | `action` | `add` \| `remove` \| `enable` \| `disable` | *required* | Action |
	389	+ | `name` | string | *required* | Item name |
	390	+ | `command` | string | -- | Command (for add) |
	391	+ | `location` | `registry` \| `startup_folder` | `registry` | Where to add |
	392	+
	393	+ ---
	394	+
	395	+ ## Task Scheduler
	396	+
	397	+ ### windows_task_scheduler_list
	398	+
	399	+ | Parameter | Type | Default | Description |
	400	+ |-----------|------|---------|-------------|
	401	+ | `folder` | string | `\` | Task folder path |
	402	+ | `filter` | string | -- | Filter by name |
	403	+
	404	+ ### windows_task_scheduler_manage
	405	+
	406	+ | Parameter | Type | Description |
	407	+ |-----------|------|-------------|
	408	+ | `action` | `create` \| `delete` \| `enable` \| `disable` \| `run` | Action |
	409	+ | `name` | string | Task name |
	410	+ | `command` | string | Command (for create) |
	411	+ | `arguments` | string | Arguments (for create) |
	412	+ | `trigger` | `once` \| `daily` \| `weekly` \| `hourly` \| `logon` \| `startup` | Trigger type |
	413	+ | `time` | string | Time as HH:mm |
	414	+ | `interval` | number | Minutes (for hourly) |
	415	+
	416	+ ---
	417	+
	418	+ ## Dialogs
	419	+
	420	+ ### windows_dialog
	421	+
	422	+ | Parameter | Type | Default | Description |
	423	+ |-----------|------|---------|-------------|
	424	+ | `type` | `message` \| `input` \| `file_open` \| `file_save` \| `folder` | *required* | Dialog type |
	425	+ | `title` | string | `mcp_windows` | Title |
	426	+ | `message` | string | -- | Message text |
	427	+ | `buttons` | `ok` \| `okcancel` \| `yesno` \| `yesnocancel` | `ok` | Buttons (message) |
	428	+ | `filter` | string | -- | File filter |
	429	+ | `default_path` | string | -- | Default path |
	430	+
	431	+ ---
	432	+
	433	+ ## Configuration
	434	+
	435	+ ### windows_mcp_config
	436	+
	437	+ | Parameter | Type | Default | Description |
	438	+ |-----------|------|---------|-------------|
	439	+ | `action` | `get` \| `set` | `get` | Action |
	440	+ | `key` | string | -- | Config key |
	441	+ | `value` | string | -- | Value (JSON for arrays) |
	442	+
	443	+ ---
	444	+
	445	+ *Repo: [mcp-windows](https://git.mokoconsulting.tech/MokoConsulting/mcp-windows) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/mokoplatform/wiki/Home)*
	446	+
	447	+ | Field | Value |
	448	+ |---|---|
	449	+ | Minimum Version | 05.00.00 |
	450	+ | Platform | mcp-server |
	451	+ | Applies To | mcp-windows |
	452	+
	453	+ | Revision | Date | Author | Description |
	454	+ |---|---|---|---|
	455	+ | 1.0 | 2026-05-25 | Moko Consulting | Initial version |
	456	+