Skip to content

Commit 87df7c6

Browse files
committed
update readme
1 parent a04dd1d commit 87df7c6

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed
666 KB
Loading

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ Available Commands:
112112
get-prompt Get a prompt on the MCP server
113113
read-resource Read a resource on the MCP server
114114
shell Start an interactive shell for MCP commands
115+
web Start a web interface for MCP commands
115116
mock Create a mock MCP server with tools, prompts, and resources
116117
proxy Proxy MCP tool requests to shell scripts
117118
alias Manage MCP server aliases
@@ -320,6 +321,33 @@ Special Commands:
320321
/q, /quit, exit Exit the shell
321322
```
322323

324+
### Web Interface
325+
326+
MCP Tools provides a web interface for interacting with MCP servers through a browser-based UI:
327+
328+
```bash
329+
# Start a web interface for a filesystem server on default port (41999)
330+
mcp web npx -y @modelcontextprotocol/server-filesystem ~
331+
332+
# Use a custom port
333+
mcp web --port 8080 npx -y @modelcontextprotocol/server-filesystem ~
334+
```
335+
336+
The web interface includes:
337+
338+
- A sidebar listing all available tools, resources, and prompts
339+
- Form-based and JSON-based parameter editing
340+
- Formatted and raw JSON response views
341+
- Interactive parameter forms automatically generated from tool schemas
342+
- Support for complex parameter types (arrays, objects, nested structures)
343+
- Direct API access for tool calling
344+
345+
Once started, you can access the interface by opening `http://localhost:41999` (or your custom port) in a browser.
346+
347+
<p align="center">
348+
<img src=".github/resources/web-interface.png" alt="MCP Web Interface" width="700">
349+
</p>
350+
323351
### Project Scaffolding
324352

325353
MCP Tools provides a scaffolding feature to quickly create new MCP servers with TypeScript:

0 commit comments

Comments
 (0)