diff --git a/plugins-external/mcp-server/README.md b/plugins-external/mcp-server/README.md index df53a7a4..fe2378aa 100644 --- a/plugins-external/mcp-server/README.md +++ b/plugins-external/mcp-server/README.md @@ -1,54 +1,35 @@ # Yaak MCP Server Plugin -A Yaak plugin that exposes Yaak's functionality via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), allowing AI assistants and other tools to interact with Yaak programmatically. +Exposes Yaak's functionality via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/). -## Features +## Setup -This plugin starts an MCP server on `http://127.0.0.1:64343/mcp` that provides tools for: +Add this to your Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS): + +```json +{ + "mcpServers": { + "yaak": { + "command": "npx", + "args": ["-y", "mcp-remote", "http://127.0.0.1:64343/mcp"] + } + } +} +``` + +Restart Claude Desktop and make sure Yaak is running. + +## Available Tools -### HTTP Requests - `list_http_requests` - List all HTTP requests in a workspace - `get_http_request` - Get details of a specific HTTP request - `send_http_request` - Send an HTTP request and get the response - `create_http_request` - Create a new HTTP request - `update_http_request` - Update an existing HTTP request - `delete_http_request` - Delete an HTTP request - -### Folders - `list_folders` - List all folders in a workspace - -### Workspaces -- `list_workspaces` - List all open workspaces in Yaak - -### Clipboard -- `copy_to_clipboard` - Copy text to the system clipboard - -### Window +- `list_workspaces` - List all open workspaces - `get_workspace_id` - Get the current workspace ID - `get_environment_id` - Get the current environment ID - -### Toast Notifications +- `copy_to_clipboard` - Copy text to the system clipboard - `show_toast` - Show a toast notification in Yaak - -## Usage - -Once the plugin is installed and Yaak is running, the MCP server will be available at: - -``` -http://127.0.0.1:64343/mcp -``` - -Configure your MCP client to connect to this endpoint to start interacting with Yaak. - -## Development - -```bash -# Install dependencies -npm install - -# Build the plugin -npm run build - -# Development mode with auto-rebuild -npm run dev -``` diff --git a/plugins-external/mcp-server/package.json b/plugins-external/mcp-server/package.json index d582b6e4..adebf239 100644 --- a/plugins-external/mcp-server/package.json +++ b/plugins-external/mcp-server/package.json @@ -1,7 +1,7 @@ { "name": "@yaak/mcp-server", "private": true, - "version": "0.1.0", + "version": "0.1.3", "displayName": "MCP Server", "description": "Expose Yaak functionality via Model Context Protocol", "minYaakVersion": "2025.10.0-beta.6",