## 🚀 Quick Start ```bash # Install YAMCP npm install -g yamcp # or use npx yamcp # Import servers (choose one) yamcp server import [config] # import servers from config file (see src/example-servers.json for format) yamcp server add # or add manually # create workspaces (e.g. a yam for coding, design, data, ...) yamcp yam create # Run workspace in your AI app yamcp run ``` ## 🔑 Key Concepts - **MCP Servers**: Remote or local servers that provide Model Context Protocol services - **Workces (YAMs)**: Collections of MCP servers grouped together to be shared with AI Apps (e.g. a workce for coding, writing, design, magic making!) - **Gateway**: A local MCP server that manages connections to configured MCP servers in a workce and exposes them through a unified server to AI App's MCP clients With YAMCP, you can: - Create workces to group MCP servers by AI application (e.g. Cursor, Claude, GitHub Copilot) - Group servers by workflow purpose (e.g. software development, data science, technical writing) - Connect AI apps to a single gateway that provides access to all workce servers - Manage and monitor multiple MCP server connections through a unified interface - Track all server communications with detailed logging and debugging capabilities ## Top-Level Commands ```bash yamcp [command] [subcommand] [flags] ``` Available top-level commands: - `server` - Manage MCP providers - `yam` - Manage workspaces (yams) - `run` - Run the gateway with a workspace - `log` - View the server log location --- ## 🔧 **Mcp Server Management Commands** ### Server Commands ```bash yamcp server add # Add a new MCP server (interactive) yamcp server list # List all configured servers and their status yamcp server remove # Remove a server configuration yamcp server import # Import server configurations from a JSON file ``` --- ## 🍠 **Yam Workspace Management Commands** ### Workspace Commands ```bash yamcp yam create # Create a new workspace (interactive) yamcp yam list # List all workspaces or show specific workspace details yamcp yam edit # Modify an existing workspace configuration yamcp yam scan # Scan workspaces yamcp yam delete # Delete a workspace ``` ### Runtime Commands ```bash yamcp run # Start the gateway with specified workspace yamcp log # View server communication logs ``` --- ## ✅ Command Reference | Command | Description | Example | | ----------------- | ----------------------- | ------------------------------------ | | `server add` | Add a new MCP server | `yamcp server add` | | `server list` | List configured servers | `yamcp server list` | | `server remove` | Remove a server | `yamcp server remove [name]` | | `server import` | Import server config | `yamcp server import [config]` | | `yam create` | Create workspace | `yamcp yam create` | | `yam list` | List workspaces | `yamcp yam list` | | `yam list --name` | Show workspace details | `yamcp yam list --name my-workspace` | | `yam edit` | Edit workspace | `yamcp yam edit` | | `yam scan ` | Scan workspace | `yamcp yam scan [workspace-name]` | | `yam delete` | Delete workspace | `yamcp yam delete [workspace-name]` | | `run` | Start gateway | `yamcp run ` | | `log` | View logs | `yamcp log` | --- ## 🏗️ System Architecture ```mermaid graph TB CLI[CLI Commands] GW[McpGateway] GS[GatewayServer] GR[GatewayRouter] LOG[Logger] STORE[(Store)] AI_APP[AI App] %% CLI Command Flow CLI -->|manages| STORE CLI -->|runs| GW %% Gateway Com

🍠 YAMCP - A Model Context Workspace Manager

コメント