Skip to content

Commit 0500460

Browse files
Dumbrisclaude
andauthored
docs: add introduction page with architecture diagram (smart-mcp-proxy#203)
* docs: add introduction page with architecture diagram Add a new introduction page as the default landing page for docs.mcpproxy.app featuring: - Architecture diagram showing AI clients → MCPProxy → MCP servers flow - Overview of key features: intelligent tool discovery, security quarantine, containerized MCP servers, and audit/transparency - Getting started links and ecosystem overview 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: remove redirect to allow intro page as homepage Delete src/pages/index.js which was redirecting / to /getting-started/installation. Now the intro.md with slug: / properly serves as the docs homepage. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: enable MDX format detection for Tabs components Change markdown format from 'md' to 'detect' so that files using MDX components (Tabs, TabItem, admonitions) are processed correctly. This fixes the raw import statements showing on quick-start page. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 27555c4 commit 0500460

5 files changed

Lines changed: 90 additions & 8 deletions

File tree

docs/intro.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
id: intro
3+
title: Introduction
4+
sidebar_label: Introduction
5+
sidebar_position: 0
6+
slug: /
7+
description: MCPProxy - Smart MCP Proxy for AI Agents with intelligent tool discovery, security quarantine, and Docker isolation
8+
keywords: [mcp, proxy, ai agents, tool discovery, security, docker]
9+
---
10+
11+
# MCPProxy
12+
13+
**A smart proxy for AI agents using the Model Context Protocol (MCP)**
14+
15+
![MCPProxy Architecture](/img/mcpproxy-architecture.jpeg)
16+
17+
## What is MCPProxy?
18+
19+
MCPProxy is a Go-based application that acts as an intelligent proxy between AI clients (like Cursor, Claude Desktop, VS Code Copilot) and MCP servers. It runs locally on your machine or LAN and provides:
20+
21+
- **Intelligent Tool Discovery** - BM25 search indexes tools across all connected servers, reducing token usage and preventing context bloat
22+
- **Security Quarantine** - Blocks Tool Poisoning Attacks (TPA) by quarantining new servers until manually approved
23+
- **Containerized MCP Servers** - Run upstream servers in Docker isolation for enhanced security
24+
- **Audit & Transparency** - Full logging of all tool calls for debugging and compliance
25+
26+
## Key Features
27+
28+
### Intelligent Tool Discovery
29+
30+
Instead of loading all tools from all servers into your AI client's context, MCPProxy indexes tools using BM25 search. Your AI client queries for relevant tools and only receives what it needs, dramatically reducing token usage.
31+
32+
### Security Quarantine
33+
34+
New MCP servers are automatically quarantined until you review and approve them. This protects against Tool Poisoning Attacks where malicious servers might try to manipulate AI behavior through crafted tool descriptions.
35+
36+
### Docker Isolation
37+
38+
Run MCP servers inside Docker containers with automatic runtime detection (Python/Node.js), environment variable passing, and proper container lifecycle management.
39+
40+
### Multiple Control Interfaces
41+
42+
MCPProxy is controllable via:
43+
- **CLI** - Full command-line interface for scripting and automation
44+
- **Web UI** - Browser-based dashboard for visual management
45+
- **Tray Menu** - System tray application for quick access (macOS/Windows/Linux)
46+
47+
## Architecture
48+
49+
MCPProxy consists of two components:
50+
51+
- **Core Server** (`mcpproxy`) - Headless HTTP API server with MCP proxy functionality
52+
- **Tray Application** (`mcpproxy-tray`) - Optional GUI that manages the core server
53+
54+
The core server binds to `127.0.0.1:8080` by default (localhost-only for security) and can be configured for LAN access if needed.
55+
56+
## Getting Started
57+
58+
Ready to get started? Follow the [Installation Guide](/getting-started/installation) to install MCPProxy on your system, then proceed to the [Quick Start](/getting-started/quick-start) guide to configure your first MCP servers.
59+
60+
## Ecosystem
61+
62+
MCPProxy works with any MCP-compatible client and connects to 100+ MCP servers providing 1000+ tools. Popular integrations include:
63+
64+
**AI Clients:**
65+
- Cursor
66+
- Claude Desktop
67+
- VS Code Copilot
68+
- ChatGPT/Codex
69+
- Goose
70+
- Windsurf
71+
72+
**MCP Servers:**
73+
- GitHub
74+
- Playwright
75+
- Context7
76+
- Jira
77+
- Filesystem
78+
- Slack
79+
- PostgreSQL
80+
- And many more...
81+
82+
## Links
83+
84+
- [GitHub Repository](https://github.com/smart-mcp-proxy/mcpproxy-go)
85+
- [Main Website](https://mcpproxy.app)
86+
- [Release Notes](https://github.com/smart-mcp-proxy/mcpproxy-go/releases)

website/docusaurus.config.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ const config = {
2222
onBrokenMarkdownLinks: 'warn',
2323

2424
markdown: {
25-
format: 'md',
25+
format: 'detect',
2626
},
2727

2828
i18n: {
@@ -41,6 +41,7 @@ const config = {
4141
editUrl: 'https://github.com/smart-mcp-proxy/mcpproxy-go/edit/main/',
4242
// Only include structured documentation pages
4343
include: [
44+
'intro.md',
4445
'getting-started/**/*.{md,mdx}',
4546
'configuration/**/*.{md,mdx}',
4647
'cli/**/*.{md,mdx}',
@@ -103,7 +104,7 @@ const config = {
103104
logo: {
104105
alt: 'MCPProxy Logo',
105106
src: 'img/logo.svg',
106-
href: '/getting-started/installation',
107+
href: '/',
107108
},
108109
items: [
109110
{

website/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
1515
const sidebars = {
1616
docs: [
17+
'intro',
1718
{
1819
type: 'category',
1920
label: 'Getting Started',

website/src/pages/index.js

Lines changed: 0 additions & 6 deletions
This file was deleted.
2.39 MB
Loading

0 commit comments

Comments
 (0)