From 9da74792d5c6364d24ab6b727cd65790da3de878 Mon Sep 17 00:00:00 2001 From: B Harper Date: Sun, 26 Oct 2025 19:11:27 +1100 Subject: [PATCH] Update documentation and add additional README content --- README-Additional.md | 68 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 67 +++++-------------------------------------- 2 files changed, 75 insertions(+), 60 deletions(-) create mode 100644 README-Additional.md diff --git a/README-Additional.md b/README-Additional.md new file mode 100644 index 0000000..6db92f1 --- /dev/null +++ b/README-Additional.md @@ -0,0 +1,68 @@ +# HumanAgent MCP + +VS Code extension that creates an MCP server for AI assistants to chat with humans. + +## What it does + +This extension provides a `HumanAgent_Chat` MCP tool that forces AI assistants to communicate through a human agent instead of giving direct responses. When an AI uses this tool, it opens a chat session where humans can respond in real-time. + +## Why + +The AI Agent is encouraged to discuss with you before running off to do its own thing - if its part way through iterating through on a problem it can stop and ask you a question - it reduces requests considerably, helps avoid runaway agent, allows you to manage multiple VSCode agents working in multiple workspaces from one web page. Allows you to append useful reminders to each response. + +## How it works + +- Extension starts MCP server on port 3737 +- Registers `HumanAgent_Chat` tool with VS Code MCP system +- AI assistants must use this tool for all interactions +- Creates persistent chat sessions with message history +- Provides VS Code webview and browser interfaces for human responses + +## Installation and Setup + +1. Install the extension in VS Code +2. Extension activates automatically on startup +3. MCP server starts and registers with VS Code +4. Tool becomes available to AI assistants immediately + +## Chat Interfaces + +**VS Code Panel**: Dockable chat interface within VS Code +**Browser Interface**: Available at `http://localhost:3737/HumanAgent` + +Both interfaces show the same chat sessions and message history. + +## Tool Customization + +Create `.vscode/HumanAgentOverride.json` to customize tool descriptions and message behavior: + +```json +{ + "version": "1.0.0", + "description": "Override file for workspace tool configurations", + "tools": { + "HumanAgent_Chat": { + "name": "HumanAgent_Chat", + "description": "Your custom description here" + } + }, + "messageSettings": { + "global": { + "autoAppendEnabled": false, + "autoAppendText": "" + }, + "toolSpecific": { + "HumanAgent_Chat": { + "autoAppendEnabled": true, + "autoAppendText": "No need to confirm this next part - Remember allways to reply here in this tool unless user suggests otherwise" + } + } + } +} +``` + +Changes require VS Code restart to take effect. + +## Requirements + +VS Code version 1.105.0 or higher with native MCP support. diff --git a/README.md b/README.md index d2588ef..904b2c5 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,11 @@ -# HumanAgent MCP - -VS Code extension that creates an MCP server for AI assistants to chat with humans. - -## What it does +# What This extension provides a `HumanAgent_Chat` MCP tool that forces AI assistants to communicate through a human agent instead of giving direct responses. When an AI uses this tool, it opens a chat session where humans can respond in real-time. +## Why + +The AI Agent is encouraged to discuss with you before running off to do its own thing - if its part way through iterating through on a problem it can stop and ask you a question - it reduces requests considerably, helps avoid runaway agent, allows you to manage multiple VSCode agents working in multiple workspaces from one web page. Allows you to append useful reminders to each response. + ## How it works - -- Extension starts MCP server on port 3737 -- Registers `HumanAgent_Chat` tool with VS Code MCP system -- AI assistants must use this tool for all interactions -- Creates persistent chat sessions with message history -- Provides VS Code webview and browser interfaces for human responses - -## Installation and Setup - -1. Install the extension in VS Code -2. Extension activates automatically on startup -3. MCP server starts and registers with VS Code -4. Tool becomes available to AI assistants immediately - -## Chat Interfaces - -**VS Code Panel**: Dockable chat interface within VS Code -**Browser Interface**: Available at `http://localhost:3737/HumanAgent` - -Both interfaces show the same chat sessions and message history. - -## Tool Customization - -Create `.vscode/HumanAgentOverride.json` to customize tool descriptions and message behavior: - -```json -{ - "version": "1.0.0", - "description": "Override file for workspace tool configurations", - "tools": { - "HumanAgent_Chat": { - "name": "HumanAgent_Chat", - "description": "Your custom description here" - } - }, - "messageSettings": { - "global": { - "autoAppendEnabled": false, - "autoAppendText": "" - }, - "toolSpecific": { - "HumanAgent_Chat": { - "autoAppendEnabled": true, - "autoAppendText": "No need to confirm this next part - Remember allways to reply here in this tool unless user suggests otherwise" - } - } - } -} -``` - -Changes require VS Code restart to take effect. - -## Requirements - -VS Code version 1.105.0 or higher with native MCP support. +Just install it and its ready to go. +For more information see https://github.com/3DTek-xyz/HumanAgent-MCP/blob/master/README-Additional.md