Skip to content

Commit 49d8d32

Browse files
committed
refactor: update tool names for consistency and clarity across documentation and examples
1 parent 31f15c6 commit 49d8d32

File tree

8 files changed

+28
-44
lines changed

8 files changed

+28
-44
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ Your capabilities include:
7474
- Interacting with GitHub to create pull requests and manage issues
7575
7676
To perform these actions, you must use the following tools:
77-
- To execute a shell command: <tool name="desktop-commander.exec" />
78-
- To read a file's content: <tool name="desktop-commander.readFile" />
79-
- To write content to a file: <tool name="desktop-commander.writeFile" />
77+
- To execute a shell command: <tool name="desktop-commander.execute_command" />
78+
- To read a file's content: <tool name="desktop-commander.read_file" />
79+
- To write content to a file: <tool name="desktop-commander.write_file" />
8080
- To find symbol definitions: <tool name="lsmcp.definition" />
8181
- To create a GitHub pull request: <tool name="github.createPullRequest" />
8282
`;

docs/examples/creating-a-codex-fork.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,25 @@ const deps: ComposeDefinition["deps"] = {
4545
const description = `
4646
You are a "codex fork" agent, a world-class AI assistant for coding tasks.
4747
48-
Your capabilities include:
49-
- Reading and writing files.
50-
- Searching the codebase using advanced language server features.
51-
- Executing terminal commands to build, test, and run projects.
52-
- Interacting with GitHub to create pull requests and manage issues.
48+
Workflow:
49+
1. Project Overview: Use <tool name="lsmcp.get_project_overview"/> to understand the project structure.
50+
2. Code Discovery: Locate relevant files using <tool name="lsmcp.search_symbols"/>, <tool name="desktop-commander.search_code"/>, or <tool name="desktop-commander.list_directory"/>.
51+
3. Implementation: Apply changes with <tool name="desktop-commander.edit_block"/> and verify with <tool name="lsmcp.lsp_get_diagnostics"/>.
52+
4. Build and Commit: Execute build commands with <tool name="desktop-commander.execute_command"/>, then commit changes.
53+
5. Submission: Create pull requests with <tool name="github.createPullRequest"/>.
5354
54-
To perform these actions, you must use the following tools:
55-
- To execute a shell command: <tool name="desktop-commander.exec" />
56-
- To read a file's content: <tool name="desktop-commander.readFile" />
57-
- To write content to a file: <tool name="desktop-commander.writeFile" />
58-
- To find symbol definitions: <tool name="lsmcp.definition" />
59-
- To create a GitHub pull request: <tool name="github.createPullRequest" />
55+
Available tools:
56+
<tool name="desktop-commander.execute_command"/>
57+
<tool name="desktop-commander.read_file"/>
58+
<tool name="desktop-commander.write_file"/>
59+
<tool name="desktop-commander.edit_block"/>
60+
<tool name="desktop-commander.search_code"/>
61+
<tool name="desktop-commander.list_directory"/>
62+
<tool name="lsmcp.get_project_overview"/>
63+
<tool name="lsmcp.search_symbols"/>
64+
<tool name="lsmcp.definition"/>
65+
<tool name="lsmcp.lsp_get_diagnostics"/>
66+
<tool name="github.createPullRequest"/>
6067
`;
6168

6269
// 3. Finally, Start the Agentic MCP Server

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Code/compatible clients.
4141
Use `<tool name="server.toolname" />` syntax:
4242

4343
```xml
44-
<tool name="desktop-commander.exec" />
44+
<tool name="desktop-commander.execute_command" />
4545
<tool name="github.createPullRequest" />
4646
```
4747

packages/cli/examples/05-url-config.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ echo ""
1212
GITHUB_USER="mcpc-tech"
1313
REPO_NAME="mcpc"
1414
BRANCH="main"
15-
CONFIG_PATH="packages/cli/examples/configs/simple.json"
15+
CONFIG_PATH="packages/cli/examples/configs/codex-fork.json"
1616

1717
export MCPC_CONFIG_URL="https://raw.githubusercontent.com/${GITHUB_USER}/${REPO_NAME}/${BRANCH}/${CONFIG_PATH}"
1818

packages/cli/examples/configs/README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,6 @@ This directory contains example configuration files for MCPC CLI.
44

55
## Available Configs
66

7-
### simple.json
8-
9-
A minimal configuration for testing basic functionality.
10-
11-
```bash
12-
# Use with MCPC_CONFIG_FILE
13-
export MCPC_CONFIG_FILE=examples/configs/simple.json
14-
deno run --allow-all src/bin.ts
15-
```
16-
177
### codex-fork.json
188

199
A full-featured "Codex Fork" agent based on the MCPC documentation example.
@@ -41,7 +31,7 @@ After pushing to GitHub, these configs can be loaded via URL:
4131

4232
```bash
4333
# Load simple config from GitHub
44-
export MCPC_CONFIG_URL="https://raw.githubusercontent.com/mcpc-tech/mcpc/main/packages/cli/examples/configs/simple.json"
34+
export MCPC_CONFIG_URL="https://raw.githubusercontent.com/mcpc-tech/mcpc/main/packages/cli/examples/configs/codex-fork.json"
4535
deno run --allow-all src/bin.ts
4636

4737
# Or use the example script

packages/cli/examples/configs/codex-fork.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"agents": [
99
{
1010
"name": "codex-fork-agent",
11-
"description": "You are a \"codex fork\" agent, a world-class AI assistant for coding tasks.\n\nYour capabilities include:\n- Reading and writing files.\n- Searching the codebase using advanced language server features.\n- Executing terminal commands to build, test, and run projects.\n- Interacting with GitHub to create pull requests and manage issues.\n\nTo perform these actions, you must use the following tools:\n- To execute a shell command: <tool name=\"desktop-commander.exec\" />\n- To read a file's content: <tool name=\"desktop-commander.readFile\" />\n- To write content to a file: <tool name=\"desktop-commander.writeFile\" />\n- To find symbol definitions: <tool name=\"lsmcp.definition\" />\n- To create a GitHub pull request: <tool name=\"github.createPullRequest\" />",
11+
"description": "You are a \"codex fork\" agent, a world-class AI assistant for coding tasks.\n\nWorkflow:\n1. Project Overview: Use <tool name=\"lsmcp.get_project_overview\"/> to understand the project structure.\n2. Code Discovery: Locate relevant files using <tool name=\"lsmcp.search_symbols\"/>, <tool name=\"desktop-commander.search_code\"/>, or <tool name=\"desktop-commander.list_directory\"/>.\n3. Implementation: Apply changes with <tool name=\"desktop-commander.edit_block\"/> and verify with <tool name=\"lsmcp.lsp_get_diagnostics\"/>.\n4. Build and Commit: Execute build commands with <tool name=\"desktop-commander.execute_command\"/>, then commit changes.\n5. Submission: Create pull requests with <tool name=\"github.createPullRequest\"/>.\n\nAvailable tools:\n<tool name=\"desktop-commander.execute_command\"/>\n<tool name=\"desktop-commander.read_file\"/>\n<tool name=\"desktop-commander.write_file\"/>\n<tool name=\"desktop-commander.edit_block\"/>\n<tool name=\"desktop-commander.search_code\"/>\n<tool name=\"desktop-commander.list_directory\"/>\n<tool name=\"lsmcp.get_project_overview\"/>\n<tool name=\"lsmcp.search_symbols\"/>\n<tool name=\"lsmcp.definition\"/>\n<tool name=\"lsmcp.lsp_get_diagnostics\"/>\n<tool name=\"github.createPullRequest\"/>",
1212
"options": {
1313
"mode": "agentic"
1414
},

packages/cli/examples/configs/simple.json

Lines changed: 0 additions & 13 deletions
This file was deleted.

packages/core/mod.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
* I am a coding assistant that can read files and run terminal commands.
2424
*
2525
* Available tools:
26-
* <tool name="desktop-commander.exec" />
27-
* <tool name="desktop-commander.readFile" />
28-
* <tool name="desktop-commander.writeFile" />
26+
* <tool name="desktop-commander.execute_command" />
27+
* <tool name="desktop-commander.read_file" />
28+
* <tool name="desktop-commander.write_file" />
2929
* `
3030
*
3131
* // Create and start the server

0 commit comments

Comments
 (0)