wcgw 1.2.2__tar.gz → 1.4.0__tar.gz

{wcgw-1.2.2 → wcgw-1.4.0}/.vscode/settings.json

@@ -9,7 +9,8 @@
     ],
     "mypy-type-checker.args": [
         "--enable-incomplete-feature=NewGenericSyntax",
-        "--strict"
+        "--strict",
+        
     ],
     "editor.formatOnSave": true,
     "editor.renderWhitespace": "selection",

{wcgw-1.2.2 → wcgw-1.4.0}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.3
 Name: wcgw
-Version: 1.2.2
+Version: 1.4.0
 Summary: What could go wrong giving full shell access to chatgpt?
 Project-URL: Homepage, https://github.com/rusiaaman/wcgw
 Author-email: Aman Rusia <gapypi@arcfu.com>
 Requires-Python: <3.13,>=3.10
 Requires-Dist: anthropic>=0.39.0
 Requires-Dist: fastapi>=0.115.0
+Requires-Dist: mcp>=1.0.0
 Requires-Dist: mypy>=1.11.2
 Requires-Dist: nltk>=3.9.1
 Requires-Dist: openai>=1.46.0
@@ -50,7 +51,7 @@ You need to keep running this client for GPT to access your shell. Run it in a v
 ### Option 1: using uv [Recommended]
 ```sh
 $ curl -LsSf https://astral.sh/uv/install.sh | sh
-$ uv tool run --python 3.12 wcgw@latest
+$ uvx wcgw@latest
 ```
 
 ### Option 2: using pip
@@ -109,6 +110,9 @@ If you don't have public ip and domain name, you can use `ngrok` or similar serv
 The specify the server url in the `wcgw` command like so
 `wcgw --server-url https://your-url/v1/register`
 
+# Claude Support
+WCGW now supports Claude Desktop through the MCP protocol, allowing you to use Claude's capabilities directly from your desktop environment. This integration enables seamless interaction between Claude and your local shell.
+
 # [Optional] Local shell access with openai API key
 
 Add `OPENAI_API_KEY` and `OPENAI_ORG_ID` env variables.

{wcgw-1.2.2 → wcgw-1.4.0}/README.md

@@ -22,7 +22,7 @@ You need to keep running this client for GPT to access your shell. Run it in a v
 ### Option 1: using uv [Recommended]
 ```sh
 $ curl -LsSf https://astral.sh/uv/install.sh | sh
-$ uv tool run --python 3.12 wcgw@latest
+$ uvx wcgw@latest
 ```
 
 ### Option 2: using pip
@@ -81,6 +81,9 @@ If you don't have public ip and domain name, you can use `ngrok` or similar serv
 The specify the server url in the `wcgw` command like so
 `wcgw --server-url https://your-url/v1/register`
 
+# Claude Support
+WCGW now supports Claude Desktop through the MCP protocol, allowing you to use Claude's capabilities directly from your desktop environment. This integration enables seamless interaction between Claude and your local shell.
+
 # [Optional] Local shell access with openai API key
 
 Add `OPENAI_API_KEY` and `OPENAI_ORG_ID` env variables.

wcgw-1.4.0/add.py

@@ -0,0 +1,6 @@
+def add_numbers(a: int, b: int) -> int:
+    return a + b
+
+# Test the function
+result = add_numbers(5, 3)
+print(f"5 + 3 = {result}")

wcgw-1.4.0/claude_desktop_config.json

@@ -0,0 +1,15 @@
+{
+  "mcpServers": {
+    "wcgw": {
+      "command": "uvx",
+      "args": [
+        "--from",
+        "wcgw",
+        "wcgw_mcp"
+      ],
+      "protocol": "mcp",
+      "defaultModel": "claude-3-sonnet",
+      "maxTokens": 4096
+    }
+  }
+}

{wcgw-1.2.2 → wcgw-1.4.0}/gpt_action_json_schema.json

@@ -249,6 +249,46 @@
           }
         }
       }
+    },
+    "/v1/initialize": {
+      "post": {
+        "x-openai-isConsequential": false,
+        "summary": "Initialize",
+        "operationId": "initialize_v1_initialize_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/InitializeWithUUID"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "title": "Response Initialize V1 Initialize Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -320,8 +360,8 @@
         },
         "type": "object",
         "required": [
-          "user_id",
-          "type"
+          "type",
+          "user_id"
         ],
         "title": "BashInteractionWithUUID"
       },
@@ -405,6 +445,29 @@
         "type": "object",
         "title": "HTTPValidationError"
       },
+      "InitializeWithUUID": {
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "Initialize"
+            ],
+            "const": "Initialize",
+            "title": "Type"
+          },
+          "user_id": {
+            "type": "string",
+            "format": "uuid",
+            "title": "User Id"
+          }
+        },
+        "type": "object",
+        "required": [
+          "type",
+          "user_id"
+        ],
+        "title": "InitializeWithUUID"
+      },
       "ReadFileWithUUID": {
         "properties": {
           "file_path": {
@@ -441,8 +504,7 @@
               true
             ],
             "const": true,
-            "title": "Should Reset",
-            "default": true
+            "title": "Should Reset"
           },
           "user_id": {
             "type": "string",
@@ -452,8 +514,8 @@
         },
         "type": "object",
         "required": [
-          "user_id",
-          "should_reset"
+          "should_reset",
+          "user_id"
         ],
         "title": "ResetShellWithUUID"
       },

{wcgw-1.2.2 → wcgw-1.4.0}/gpt_instructions.txt

@@ -1,12 +1,14 @@
 You're an expert software engineer with shell and code knowledge.
 
 Instructions:
-
+   
     - You should use the provided bash execution, reading and writing file tools to complete objective.
     - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
     - Always read relevant files before editing.
     - Do not provide code snippets unless asked by the user, instead directly edit the code.
 
+Instructions for `Initialize`:
+    - Always call this at the start of the conversation.
 
 Instructions for `BashCommand`:
 - Execute a bash command. This is stateful (beware with subsequent calls).
@@ -14,6 +16,7 @@ Instructions for `BashCommand`:
 - Status of the command and the current working directory will always be returned at the end.
 - Optionally `exit shell has restarted` is the output, in which case environment resets, you can run fresh commands.
 - The first line might be `(...truncated)` if the output is too long.
+- The control will return to you in 5 seconds regardless of the status. For heavy commands, keep checking status using BashInteraction till they are finished.
 
 Instructions for `Read File`
 - Read full content of a file.
@@ -80,7 +83,7 @@ def call_hello_renamed():
         4. The lines to replace into the source code
         5. The end of the replace block: >>>>>>> REPLACE
 
-        Every "<<<<<<< SEARCH" section must *EXACTLY MATCH* the existing file content, character for character, including all comments, docstrings, etc.
+        Every "<<<<<<< SEARCH" section must *EXACTLY MATCH* the existing file content, character for character, including all comments, docstrings, whitespaces etc.
 
         *SEARCH/REPLACE* blocks will *only* replace the first match occurrence.
         Including multiple unique *SEARCH/REPLACE* blocks if needed.
@@ -91,9 +94,12 @@ def call_hello_renamed():
         Include just the changing lines, and a few surrounding lines if needed for uniqueness.
         Do not include long runs of unchanging lines in *SEARCH/REPLACE* blocks.
 
+        Preserve leading spaces and indentations in both SEARCH and REPLACE blocks.
+
 ---
 Always run `pwd` if you get any file or directory not found error to make sure you're not lost, or to get absolute cwd.
 
 Always write production ready, syntactically correct code.
 ---
-Ask the user for the user_id `UUID` if they haven't provided in the first message.
+- Ask the user for the user_id `UUID` if they haven't provided in the first message. 
+- Call "Initialize" as soon as you get the UUID.

{wcgw-1.2.2 → wcgw-1.4.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 authors = [{ name = "Aman Rusia", email = "gapypi@arcfu.com" }]
 name = "wcgw"
-version = "1.2.2"
+version = "1.4.0"
 description = "What could go wrong giving full shell access to chatgpt?"
 readme = "README.md"
 requires-python = ">=3.10, <3.13"
@@ -25,6 +25,7 @@ dependencies = [
     "semantic-version>=2.10.0",
     "nltk>=3.9.1",
     "anthropic>=0.39.0",
+    "mcp>=1.0.0",
 ]
 
 [project.urls]
@@ -38,6 +39,7 @@ build-backend = "hatchling.build"
 wcgw_local = "wcgw:app"
 wcgw = "wcgw:listen"
 wcgw_relay = "wcgw.relay.serve:run"
+wcgw_mcp = "wcgw:mcp_server"
 
 [tool.uv]
 dev-dependencies = [

{wcgw-1.2.2 → wcgw-1.4.0}/src/wcgw/__init__.py

@@ -1,2 +1,3 @@
 from .client.cli import app
 from .client.tools import run as listen
+from .client.mcp_server import main as mcp_server

{wcgw-1.2.2 → wcgw-1.4.0}/src/wcgw/client/anthropic_client.py

@@ -29,7 +29,6 @@ from ..types_ import (
     FileEdit,
     ReadFile,
     ReadImage,
-    Writefile,
     ResetShell,
 )
 
@@ -165,6 +164,7 @@ def loop(
 - Optionally `exit shell has restarted` is the output, in which case environment resets, you can run fresh commands.
 - The first line might be `(...truncated)` if the output is too long.
 - Always run `pwd` if you get any file or directory not found error to make sure you're not lost.
+- The control will return to you in 5 seconds regardless of the status. For heavy commands, keep checking status using BashInteraction till they are finished.
 """,
         ),
         ToolParam(
@@ -193,7 +193,7 @@ def loop(
 - Write content to a new file. Provide file path and content. Use this instead of BashCommand for writing new files.
 - This doesn't create any directories, please create directories using `mkdir -p` BashCommand.
 - Provide absolute file path only.
-- For editing existing files, use FileEdit.
+- For editing existing files, use FileEdit instead of this tool.
 """,
         ),
         ToolParam(
@@ -219,7 +219,7 @@ def loop(
     uname_machine = os.uname().machine
 
     system = f"""
-You're a cli assistant.
+You're an expert software engineer with shell and code knowledge.
 
 Instructions:
 
@@ -227,10 +227,11 @@ Instructions:
     - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
     - Always read relevant files before editing.
     - Do not provide code snippets unless asked by the user, instead directly edit the code.
-    
+
 System information:
     - System: {uname_sysname}
     - Machine: {uname_machine}
+    - Current directory: {os.getcwd()}
 """
 
     with open(os.path.join(os.path.dirname(__file__), "diff-instructions.txt")) as f:
@@ -361,7 +362,7 @@ System information:
                                     enc,
                                     limit - cost,
                                     loop,
-                                    max_tokens=8096,
+                                    max_tokens=8000,
                                 )
                             except Exception as e:
                                 output_or_done = (

{wcgw-1.2.2 → wcgw-1.4.0}/src/wcgw/client/diff-instructions.txt

@@ -4,6 +4,7 @@ Instructions for editing files.
 
 Only edit the files using the following SEARCH/REPLACE blocks.
 ```
+file_edit_using_search_replace_blocks="""
 <<<<<<< SEARCH
 def hello():
     "print a greeting"
@@ -32,6 +33,7 @@ def call_hello_renamed():
     hello_renamed()
     impl2()
 >>>>>>> REPLACE
+"""
 ```
 
 # *SEARCH/REPLACE block* Rules:
@@ -43,7 +45,7 @@ Every *SEARCH/REPLACE block* must use this format:
 4. The lines to replace into the source code
 5. The end of the replace block: >>>>>>> REPLACE
 
-Every "<<<<<<< SEARCH" section must *EXACTLY MATCH* the existing file content, character for character, including all comments, docstrings, etc.
+Every "<<<<<<< SEARCH" section must *EXACTLY MATCH* the existing file content, character for character, including all comments, docstrings, whitespaces, etc.
 
 *SEARCH/REPLACE* blocks will *only* replace the first match occurrence.
 Including multiple unique *SEARCH/REPLACE* blocks if needed.
@@ -53,3 +55,5 @@ Keep *SEARCH/REPLACE* blocks concise.
 Break large *SEARCH/REPLACE* blocks into a series of smaller blocks that each change a small portion of the file.
 Include just the changing lines, and a few surrounding lines if needed for uniqueness.
 Do not include long runs of unchanging lines in *SEARCH/REPLACE* blocks.
+
+Preserve leading spaces and indentations in both SEARCH and REPLACE blocks.

wcgw-1.4.0/src/wcgw/client/mcp_server/Readme.md

@@ -0,0 +1,26 @@
+# Claude desktop support
+
+## Setup
+
+Update `claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "wcgw": {
+      "command": "uvx",
+      "args": ["--from", "wcgw", "wcgw_mcp"]
+    }
+  }
+}
+```
+
+Then restart claude app.
+
+## Usage
+
+You should be able to see this icon if everything goes right.
+
+![mcp icon](https://github.com/rusiaaman/wcgw/blob/main/static/rocket-icon.png?raw=true)
+
+Then ask claude to execute shell commands, read files, edit files, run your code, etc.

wcgw-1.4.0/src/wcgw/client/mcp_server/__init__.py

@@ -0,0 +1,11 @@
+from wcgw.client.mcp_server import server
+import asyncio
+
+
+def main():
+    """Main entry point for the package."""
+    asyncio.run(server.main())
+
+
+# Optionally expose other important items at package level
+__all__ = ["main", "server"]

wcgw-1.4.0/src/wcgw/client/mcp_server/server.py

@@ -0,0 +1,222 @@
+import asyncio
+import importlib
+import json
+import os
+import traceback
+from typing import Any
+
+from mcp.server.models import InitializationOptions
+import mcp.types as types
+from mcp.types import Tool as ToolParam
+from mcp.server import NotificationOptions, Server
+from pydantic import AnyUrl, ValidationError
+import mcp.server.stdio
+from ..tools import DoneFlag, get_tool_output, which_tool_name, default_enc
+from ...types_ import (
+    BashCommand,
+    BashInteraction,
+    CreateFileNew,
+    FileEdit,
+    ReadFile,
+    ReadImage,
+    ResetShell,
+    Initialize,
+)
+
+
+server = Server("wcgw")
+
+
+@server.list_resources()
+async def handle_list_resources() -> list[types.Resource]:
+    return []
+
+
+@server.read_resource()
+async def handle_read_resource(uri: AnyUrl) -> str:
+    raise ValueError("No resources available")
+
+
+@server.list_prompts()
+async def handle_list_prompts() -> list[types.Prompt]:
+    return []
+
+
+@server.get_prompt()
+async def handle_get_prompt(
+    name: str, arguments: dict[str, str] | None
+) -> types.GetPromptResult:
+    types.GetPromptResult(messages=[])
+
+
+@server.list_tools()
+async def handle_list_tools() -> list[types.Tool]:
+    """
+    List available tools.
+    Each tool specifies its arguments using JSON Schema validation.
+    """
+
+    with open(
+        os.path.join(
+            os.path.dirname(os.path.dirname(__file__)), "diff-instructions.txt"
+        )
+    ) as f:
+        diffinstructions = f.read()
+    return [
+        ToolParam(
+            inputSchema=Initialize.model_json_schema(),
+            name="Initialize",
+            description="""
+- Always call this at the start of the conversation before anything else.
+""",
+        ),
+        ToolParam(
+            inputSchema=BashCommand.model_json_schema(),
+            name="BashCommand",
+            description="""
+- Execute a bash command. This is stateful (beware with subsequent calls).
+- Do not use interactive commands like nano. Prefer writing simpler commands.
+- Status of the command and the current working directory will always be returned at the end.
+- Optionally `exit shell has restarted` is the output, in which case environment resets, you can run fresh commands.
+- The first line might be `(...truncated)` if the output is too long.
+- Always run `pwd` if you get any file or directory not found error to make sure you're not lost.
+- The control will return to you in 5 seconds regardless of the status. For heavy commands, keep checking status using BashInteraction till they are finished.
+""",
+        ),
+        ToolParam(
+            inputSchema=BashInteraction.model_json_schema(),
+            name="BashInteraction",
+            description="""
+- Interact with running program using this tool
+- Special keys like arrows, interrupts, enter, etc.
+- Send text input to the running program.
+- Send send_specials=["Enter"] to recheck status of a running program.
+- Only one of send_text, send_specials, send_ascii should be provided.
+""",
+        ),
+        ToolParam(
+            inputSchema=ReadFile.model_json_schema(),
+            name="ReadFile",
+            description="""
+- Read full file content
+- Provide absolute file path only
+""",
+        ),
+        ToolParam(
+            inputSchema=CreateFileNew.model_json_schema(),
+            name="CreateFileNew",
+            description="""
+- Write content to a new file. Provide file path and content. Use this instead of BashCommand for writing new files.
+- This doesn't create any directories, please create directories using `mkdir -p` BashCommand.
+- Provide absolute file path only.
+- For editing existing files, use FileEdit instead of this tool.
+""",
+        ),
+        ToolParam(
+            inputSchema=ReadImage.model_json_schema(),
+            name="ReadImage",
+            description="Read an image from the shell.",
+        ),
+        ToolParam(
+            inputSchema=ResetShell.model_json_schema(),
+            name="ResetShell",
+            description="Resets the shell. Use only if all interrupts and prompt reset attempts have failed repeatedly.",
+        ),
+        ToolParam(
+            inputSchema=FileEdit.model_json_schema(),
+            name="FileEdit",
+            description="""
+- Use absolute file path only.
+- Use SEARCH/REPLACE blocks to edit the file.
+"""
+            + diffinstructions,
+        ),
+        ToolParam(
+            inputSchema=ReadImage.model_json_schema(),
+            name="ReadImage",
+            description="""
+- Read an image from the shell.
+""",
+        ),
+    ]
+
+
+@server.call_tool()
+async def handle_call_tool(
+    name: str, arguments: dict | None
+) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
+    if not arguments:
+        raise ValueError("Missing arguments")
+
+    tool_type = which_tool_name(name)
+
+    try:
+        tool_call = tool_type(**arguments)
+    except ValidationError:
+
+        def try_json(x: str) -> Any:
+            try:
+                return json.loads(x)
+            except json.JSONDecodeError:
+                return x
+
+        tool_call = tool_type(**{k: try_json(v) for k, v in arguments.items()})
+
+    try:
+        output_or_done, _ = get_tool_output(
+            tool_call, default_enc, 0.0, lambda x, y: ("", 0), 8000
+        )
+
+    except Exception as e:
+        output_or_done = f"GOT EXCEPTION while calling tool. Error: {e}"
+        tb = traceback.format_exc()
+        print(output_or_done + "\n" + tb)
+
+    assert not isinstance(output_or_done, DoneFlag)
+    if isinstance(output_or_done, str):
+        if issubclass(tool_type, Initialize):
+            output_or_done += """
+            
+You're an expert software engineer with shell and code knowledge.
+
+Instructions:
+   
+    - You should use the provided bash execution, reading and writing file tools to complete objective.
+    - First understand about the project by getting the folder structure (ignoring .git, node_modules, venv, etc.)
+    - Always read relevant files before editing.
+    - Do not provide code snippets unless asked by the user, instead directly edit the code.
+
+    
+Additional instructions:
+    Always run `pwd` if you get any file or directory not found error to make sure you're not lost, or to get absolute cwd.
+
+    Always write production ready, syntactically correct code.
+"""
+
+        return [types.TextContent(type="text", text=output_or_done)]
+
+    return [
+        types.ImageContent(
+            type="image",
+            data=output_or_done.data,
+            mimeType=output_or_done.media_type,
+        )
+    ]
+
+
+async def main() -> None:
+    version = importlib.metadata.version("wcgw")
+    # Run the server using stdin/stdout streams
+    async with mcp.server.stdio.stdio_server() as (read_stream, write_stream):
+        await server.run(
+            read_stream,
+            write_stream,
+            InitializationOptions(
+                server_name="wcgw",
+                server_version=version,
+                capabilities=server.get_capabilities(
+                    notification_options=NotificationOptions(),
+                    experimental_capabilities={},
+                ),
+            ),
+        )

{wcgw-1.2.2 → wcgw-1.4.0}/src/wcgw/client/openai_client.py

@@ -27,7 +27,6 @@ from ..types_ import (
     FileEdit,
     ReadImage,
     ReadFile,
-    Writefile,
     ResetShell,
 )
 
@@ -148,8 +147,7 @@ def loop(
     my_dir = os.path.dirname(__file__)
 
     config = Config(
-        model=cast(
-            Models, os.getenv("OPENAI_MODEL", "gpt-4o-2024-08-06").lower()),
+        model=cast(Models, os.getenv("OPENAI_MODEL", "gpt-4o-2024-08-06").lower()),
         cost_limit=0.1,
         cost_unit="$",
         cost_file={
@@ -177,6 +175,7 @@ def loop(
 - Optionally `exit shell has restarted` is the output, in which case environment resets, you can run fresh commands.
 - The first line might be `(...truncated)` if the output is too long.
 - Always run `pwd` if you get any file or directory not found error to make sure you're not lost.
+- The control will return to you in 5 seconds regardless of the status. For heavy commands, keep checking status using BashInteraction till they are finished.
 """,
         ),
         openai.pydantic_function_tool(
@@ -201,7 +200,7 @@ def loop(
 - Write content to a new file. Provide file path and content. Use this instead of BashCommand for writing new files.
 - This doesn't create any directories, please create directories using `mkdir -p` BashCommand.
 - Provide absolute file path only.
-- For editing existing files, use FileEdit.""",
+- For editing existing files, use FileEdit instead of this tool.""",
         ),
         openai.pydantic_function_tool(
             FileEdit,
@@ -223,7 +222,7 @@ def loop(
     uname_machine = os.uname().machine
 
     system = f"""
-You're a cli assistant.
+You're an expert software engineer with shell and code knowledge.
 
 Instructions:
 
@@ -235,6 +234,7 @@ Instructions:
 System information:
     - System: {uname_sysname}
     - Machine: {uname_machine}
+    - Current directory: {os.getcwd()}
 
 """
 
@@ -341,7 +341,7 @@ System information:
                                     enc,
                                     limit - cost,
                                     loop,
-                                    max_tokens=2048,
+                                    max_tokens=8000,
                                 )
                             except Exception as e:
                                 output_or_done = (