wcgw 1.3.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

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/client/anthropic_client.py

@@ -29,7 +29,6 @@ from ..types_ import (
     FileEdit,
     ReadFile,
     ReadImage,
-    Writefile,
     ResetShell,
 )
 

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/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/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/client/openai_client.py

@@ -27,7 +27,6 @@ from ..types_ import (
     FileEdit,
     ReadImage,
     ReadFile,
-    Writefile,
     ResetShell,
 )
 

wcgw/client/tools.py

@@ -57,7 +57,6 @@ from ..types_ import (
     ReadFile,
     ReadImage,
     ResetShell,
-    Writefile,
 )
 
 from .common import CostData, Models, discard_input
@@ -96,7 +95,8 @@ def ask_confirmation(prompt: Confirmation) -> str:
     return "Yes" if response.lower() == "y" else "No"
 
 
-PROMPT = "#@@"
+PROMPT_CONST = "#@wcgw@#"
+PROMPT = PROMPT_CONST
 
 
 def start_shell() -> pexpect.spawn:  # type: ignore
@@ -125,7 +125,7 @@ def _is_int(mystr: str) -> bool:
 
 
 def _get_exit_code() -> int:
-    if PROMPT != "#@@":
+    if PROMPT != PROMPT_CONST:
         return 0
     # First reset the prompt in case venv was sourced or other reasons.
     SHELL.sendline(f"export PS1={PROMPT}")
@@ -448,7 +448,7 @@ def read_image_from_shell(file_path: str) -> ImageData:
         return ImageData(media_type=image_type, data=image_b64)  # type: ignore
 
 
-def write_file(writefile: Writefile | CreateFileNew, error_on_exist: bool) -> str:
+def write_file(writefile: CreateFileNew, error_on_exist: bool) -> str:
     if not os.path.isabs(writefile.file_path):
         return f"Failure: file_path should be absolute path, current working directory is {CWD}"
     else:
@@ -661,7 +661,6 @@ TOOLS = (
     | BashCommand
     | BashInteraction
     | ResetShell
-    | Writefile
     | CreateFileNew
     | FileEditFindReplace
     | FileEdit
@@ -687,8 +686,6 @@ def which_tool_name(name: str) -> Type[TOOLS]:
         return BashInteraction
     elif name == "ResetShell":
         return ResetShell
-    elif name == "Writefile":
-        return Writefile
     elif name == "CreateFileNew":
         return CreateFileNew
     elif name == "FileEditFindReplace":
@@ -715,7 +712,6 @@ def get_tool_output(
     | BashCommand
     | BashInteraction
     | ResetShell
-    | Writefile
     | CreateFileNew
     | FileEditFindReplace
     | FileEdit
@@ -735,7 +731,6 @@ def get_tool_output(
             | BashCommand
             | BashInteraction
             | ResetShell
-            | Writefile
             | CreateFileNew
             | FileEditFindReplace
             | FileEdit
@@ -749,7 +744,6 @@ def get_tool_output(
             | BashCommand
             | BashInteraction
             | ResetShell
-            | Writefile
             | CreateFileNew
             | FileEditFindReplace
             | FileEdit
@@ -769,9 +763,6 @@ def get_tool_output(
     elif isinstance(arg, (BashCommand | BashInteraction)):
         console.print("Calling execute bash tool")
         output = execute_bash(enc, arg, max_tokens)
-    elif isinstance(arg, Writefile):
-        console.print("Calling write file tool")
-        output = write_file(arg, False), 0
     elif isinstance(arg, CreateFileNew):
         console.print("Calling write file tool")
         output = write_file(arg, True), 0
@@ -818,7 +809,6 @@ class Mdata(BaseModel):
     data: (
         BashCommand
         | BashInteraction
-        | Writefile
         | CreateFileNew
         | ResetShell
         | FileEditFindReplace

wcgw/relay/serve.py

@@ -23,7 +23,6 @@ from ..types_ import (
     Initialize,
     ReadFile,
     ResetShell,
-    Writefile,
     Specials,
 )
 
@@ -32,7 +31,6 @@ class Mdata(BaseModel):
     data: (
         BashCommand
         | BashInteraction
-        | Writefile
         | CreateFileNew
         | ResetShell
         | FileEditFindReplace
@@ -67,8 +65,7 @@ async def register_websocket(websocket: WebSocket, uuid: UUID) -> None:
     # receive client version
     client_version = await websocket.receive_text()
     sem_version_client = semantic_version.Version.coerce(client_version)
-    sem_version_server = semantic_version.Version.coerce(
-        CLIENT_VERSION_MINIMUM)
+    sem_version_server = semantic_version.Version.coerce(CLIENT_VERSION_MINIMUM)
     if sem_version_client < sem_version_server:
         await websocket.send_text(
             Mdata(
@@ -93,8 +90,7 @@ async def register_websocket(websocket: WebSocket, uuid: UUID) -> None:
         while True:
             received_data = await websocket.receive_text()
             if uuid not in gpts:
-                raise fastapi.HTTPException(
-                    status_code=400, detail="No call made")
+                raise fastapi.HTTPException(status_code=400, detail="No call made")
             gpts[uuid](received_data)
     except WebSocketDisconnect:
         # Remove the client if the WebSocket is disconnected
@@ -281,9 +277,7 @@ async def read_file_endpoint(read_file_data: ReadFileWithUUID) -> str:
 
     gpts[user_id] = put_results
 
-    await clients[user_id](
-        Mdata(data=read_file_data, user_id=user_id)
-    )
+    await clients[user_id](Mdata(data=read_file_data, user_id=user_id))
 
     start_time = time.time()
     while time.time() - start_time < 30:
@@ -293,6 +287,7 @@ async def read_file_endpoint(read_file_data: ReadFileWithUUID) -> str:
 
     raise fastapi.HTTPException(status_code=500, detail="Timeout error")
 
+
 class InitializeWithUUID(Initialize):
     user_id: UUID
 
@@ -311,9 +306,7 @@ async def initialize(initialize_data: InitializeWithUUID) -> str:
 
     gpts[user_id] = put_results
 
-    await clients[user_id](
-        Mdata(data=initialize_data, user_id=user_id)
-    )
+    await clients[user_id](Mdata(data=initialize_data, user_id=user_id))
 
     start_time = time.time()
     while time.time() - start_time < 30:

wcgw/types_.py

@@ -24,11 +24,6 @@ class ReadImage(BaseModel):
     type: Literal["ReadImage"]
 
 
-class Writefile(BaseModel):
-    file_path: str
-    file_content: str
-
-
 class CreateFileNew(BaseModel):
     file_path: str
     file_content: str
@@ -55,4 +50,4 @@ class FileEdit(BaseModel):
 
 
 class Initialize(BaseModel):
-    type: Literal["Initialize"]
+    type: Literal["Initialize"]

{wcgw-1.3.0.dist-info → wcgw-1.4.0.dist-info}/METADATA

@@ -1,12 +1,13 @@
 Metadata-Version: 2.3
 Name: wcgw
-Version: 1.3.0
+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.4.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+wcgw/__init__.py,sha256=9K2QW7QuSLhMTVbKbBYd9UUp-ZyrfBrxcjuD_xk458k,118
+wcgw/types_.py,sha256=AWQUtzv7S_YQ2_36RMQOAA2gJ26ZQZcOA6l5EvFR6hk,1054
+wcgw/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wcgw/client/__main__.py,sha256=ngI_vBcLAv7fJgmS4w4U7tuWtalGB8c7W5qebuT6Z6o,30
+wcgw/client/anthropic_client.py,sha256=G7uCtUd5pt7ZQO7k2TJI3FtgK4QtzdIvd4Z1S18xGNU,15595
+wcgw/client/cli.py,sha256=Oja42CHkVO8puqOXflko9NeephYCMa85aBmQTEjBZtI,932
+wcgw/client/common.py,sha256=grH-yV_4tnTQZ29xExn4YicGLxEq98z-HkEZwH0ReSg,1410
+wcgw/client/diff-instructions.txt,sha256=s5AJKG23JsjwRYhFZFQVvwDpF67vElawrmdXwvukR1A,1683
+wcgw/client/openai_client.py,sha256=kQCtQX0x-jsnw-tHBxi41XqnOkCaoTUqY8K4gHeI4xM,17703
+wcgw/client/openai_utils.py,sha256=YNwCsA-Wqq7jWrxP0rfQmBTb1dI0s7dWXzQqyTzOZT4,2629
+wcgw/client/tools.py,sha256=jjQ8eFQvcE8xfoGR5WkoOgWYE0dOIThxFrrppY4gQDQ,27954
+wcgw/client/mcp_server/Readme.md,sha256=GH59caNySMMphqiimsVKrteU-jmNC7kcdBu4MPxtZZ8,477
+wcgw/client/mcp_server/__init__.py,sha256=cQ7PUrEmXUpio8x0SEoGWP5hCRPd7z2bAkNCbYbtTys,236
+wcgw/client/mcp_server/server.py,sha256=G8fyXQzVurM8rzekiXU62YaseDIT2mthc0lj64FDJKs,7089
+wcgw/relay/serve.py,sha256=RUcUeyL4Xt0EEo12Ul6VQjb4tRle4uIdsa85v7XXxEw,8771
+wcgw/relay/static/privacy.txt,sha256=s9qBdbx2SexCpC_z33sg16TptmAwDEehMCLz4L50JLc,529
+wcgw-1.4.0.dist-info/METADATA,sha256=I31G-r47C-9acBusZsKFt2BjbqgP1S83amCnQJuL_XQ,5501
+wcgw-1.4.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+wcgw-1.4.0.dist-info/entry_points.txt,sha256=eKo1omwbAggWlQ0l7GKoR7uV1-j16nk9tK0BhC2Oz_E,120
+wcgw-1.4.0.dist-info/RECORD,,

{wcgw-1.3.0.dist-info → wcgw-1.4.0.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
 wcgw = wcgw:listen
 wcgw_local = wcgw:app
+wcgw_mcp = wcgw:mcp_server
 wcgw_relay = wcgw.relay.serve:run

wcgw-1.3.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-wcgw/__init__.py,sha256=PNWvBvjUKA3aj4bHOtIqBKCAtOW88pr0hAXZ7RylVr8,68
-wcgw/types_.py,sha256=k6YhW9ePQ1oFbsPe7nQKndzJTzhulEdufvnFI3qg9vY,1124
-wcgw/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wcgw/client/__main__.py,sha256=ngI_vBcLAv7fJgmS4w4U7tuWtalGB8c7W5qebuT6Z6o,30
-wcgw/client/anthropic_client.py,sha256=yLBygok_z8Tpzedi28fpEP084wNth4qeiivZejFWRGY,15610
-wcgw/client/cli.py,sha256=Oja42CHkVO8puqOXflko9NeephYCMa85aBmQTEjBZtI,932
-wcgw/client/common.py,sha256=grH-yV_4tnTQZ29xExn4YicGLxEq98z-HkEZwH0ReSg,1410
-wcgw/client/diff-instructions.txt,sha256=s5AJKG23JsjwRYhFZFQVvwDpF67vElawrmdXwvukR1A,1683
-wcgw/client/openai_client.py,sha256=xuLsu9KHG9wssPOjTrQ6rFi3FtWufZ5RtK29Yb_j5O4,17718
-wcgw/client/openai_utils.py,sha256=YNwCsA-Wqq7jWrxP0rfQmBTb1dI0s7dWXzQqyTzOZT4,2629
-wcgw/client/tools.py,sha256=Q5qxpCjsz43aBzqpuMQ25cke_pUh3EKYeO8WC9pPpls,28225
-wcgw/relay/serve.py,sha256=ArDnLVUAtcSVxyKTzmFN-Rx09zJXRlszmNBXGrH9JtU,8863
-wcgw/relay/static/privacy.txt,sha256=s9qBdbx2SexCpC_z33sg16TptmAwDEehMCLz4L50JLc,529
-wcgw-1.3.0.dist-info/METADATA,sha256=c7_mF4ki8YX5-OBM606mcK7ZUo4YgAVF-FFeYCMIrhY,5255
-wcgw-1.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-wcgw-1.3.0.dist-info/entry_points.txt,sha256=WlIB825-Vm9ZtNzgENQsbHj4DRMkbpVR7uSkQyBlaPA,93
-wcgw-1.3.0.dist-info/RECORD,,