Initial commit: Incus MCP Server implementation
- Complete MCP server for Incus container management - 10 tools for instance lifecycle operations (create, start, stop, etc.) - 2 resources for instance and remote server data - Support for multiple Incus remotes with TLS authentication - TypeScript implementation with comprehensive error handling - Test suite for validation and integration testing - MCP configuration for Claude Code integration 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
kappa
23
.eslintrc.json
Normal file
23
.eslintrc.json
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"env": {
|
||||||
|
"node": true,
|
||||||
|
"es2022": true
|
||||||
|
},
|
||||||
|
"extends": [
|
||||||
|
"eslint:recommended",
|
||||||
|
"@typescript-eslint/recommended"
|
||||||
|
],
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2022,
|
||||||
|
"sourceType": "module"
|
||||||
|
},
|
||||||
|
"plugins": ["@typescript-eslint"],
|
||||||
|
"rules": {
|
||||||
|
"@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
|
||||||
|
"@typescript-eslint/explicit-function-return-type": "off",
|
||||||
|
"@typescript-eslint/no-explicit-any": "warn",
|
||||||
|
"prefer-const": "error",
|
||||||
|
"no-var": "error"
|
||||||
|
}
|
||||||
|
}
|
||||||
127
.gitignore
vendored
Normal file
127
.gitignore
vendored
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
# Dependencies
|
||||||
|
node_modules/
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
package-lock.json
|
||||||
|
yarn.lock
|
||||||
|
|
||||||
|
# Build output
|
||||||
|
build/
|
||||||
|
dist/
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage/
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Bower dependency directory (https://bower.io/)
|
||||||
|
bower_components
|
||||||
|
|
||||||
|
# node-waf configuration
|
||||||
|
.lock-wscript
|
||||||
|
|
||||||
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
jspm_packages/
|
||||||
|
|
||||||
|
# Snowpack dependency directory (https://snowpack.dev/)
|
||||||
|
web_modules/
|
||||||
|
|
||||||
|
# TypeScript cache
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Microbundle cache
|
||||||
|
.rpt2_cache/
|
||||||
|
.rts2_cache_cjs/
|
||||||
|
.rts2_cache_es/
|
||||||
|
.rts2_cache_umd/
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
# Output of 'npm pack'
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# Yarn Integrity file
|
||||||
|
.yarn-integrity
|
||||||
|
|
||||||
|
# dotenv environment variables file
|
||||||
|
.env
|
||||||
|
.env.test
|
||||||
|
.env.production
|
||||||
|
|
||||||
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
|
.cache
|
||||||
|
.parcel-cache
|
||||||
|
|
||||||
|
# Next.js build output
|
||||||
|
.next
|
||||||
|
|
||||||
|
# Nuxt.js build / generate output
|
||||||
|
.nuxt
|
||||||
|
dist
|
||||||
|
|
||||||
|
# Storybook build outputs
|
||||||
|
.out
|
||||||
|
.storybook-out
|
||||||
|
|
||||||
|
# Temporary folders
|
||||||
|
tmp/
|
||||||
|
temp/
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
|
||||||
|
# OS generated files
|
||||||
|
.DS_Store
|
||||||
|
.DS_Store?
|
||||||
|
._*
|
||||||
|
.Spotlight-V100
|
||||||
|
.Trashes
|
||||||
|
ehthumbs.db
|
||||||
|
Thumbs.db
|
||||||
38
.mcp.json
Normal file
38
.mcp.json
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"context7": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@upstash/context7-mcp@latest"]
|
||||||
|
},
|
||||||
|
"sequential-thinking": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-sequential-thinking"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"playwright": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"-y",
|
||||||
|
"@playwright/mcp"
|
||||||
|
],
|
||||||
|
"env": {}
|
||||||
|
},
|
||||||
|
"cloudflare": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["mcp-remote", "https://docs.mcp.cloudflare.com/sse"]
|
||||||
|
},
|
||||||
|
"podman": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"-y",
|
||||||
|
"podman-mcp-server@latest"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"incus": {
|
||||||
|
"command": "node",
|
||||||
|
"args": ["/Users/kaffa/mcp-servers/incus-mcp/build/index.js"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
8
.prettierrc
Normal file
8
.prettierrc
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"semi": true,
|
||||||
|
"trailingComma": "es5",
|
||||||
|
"singleQuote": true,
|
||||||
|
"printWidth": 100,
|
||||||
|
"tabWidth": 2,
|
||||||
|
"useTabs": false
|
||||||
|
}
|
||||||
127
CLAUDE.md
Normal file
127
CLAUDE.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
# CLAUDE.md
|
||||||
|
|
||||||
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||||
|
|
||||||
|
## Project Overview
|
||||||
|
|
||||||
|
This is the **Incus MCP Server** - a complete Model Context Protocol implementation for managing Incus containers and virtual machines. This repository contains both the MCP server implementation and configuration files for integration with Claude Code and other MCP clients.
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
### Core Implementation
|
||||||
|
- **Source Code**: TypeScript implementation in `src/` directory
|
||||||
|
- `index.ts`: Main MCP server with all tool and resource handlers
|
||||||
|
- `incus.ts`: Incus command execution utilities and error handling
|
||||||
|
- `schemas.ts`: Tool and resource schema definitions for MCP protocol
|
||||||
|
- **Build Output**: Compiled JavaScript in `build/` directory
|
||||||
|
- **Tests**: Comprehensive test suite in `test/` directory
|
||||||
|
|
||||||
|
### Configuration Files
|
||||||
|
- **package.json**: Node.js project configuration with TypeScript build system
|
||||||
|
- **tsconfig.json**: TypeScript compiler configuration
|
||||||
|
- **.mcp.json**: MCP server configuration for local development and testing
|
||||||
|
|
||||||
|
## MCP Server Configuration
|
||||||
|
|
||||||
|
### Available Servers
|
||||||
|
The `.mcp.json` file configures six MCP servers:
|
||||||
|
|
||||||
|
- **context7**: Documentation and code examples lookup using `@upstash/context7-mcp`
|
||||||
|
- **sequential-thinking**: Complex multi-step analysis using `@modelcontextprotocol/server-sequential-thinking`
|
||||||
|
- **playwright**: Browser automation and E2E testing using `@playwright/mcp`
|
||||||
|
- **cloudflare**: Cloudflare documentation access via remote MCP endpoint
|
||||||
|
- **podman**: Container management using `podman-mcp-server`
|
||||||
|
- **incus**: Local Incus container management (this project's main server)
|
||||||
|
|
||||||
|
### Claude Code Integration
|
||||||
|
The `.claude/settings.local.json` file enables all configured MCP servers for Claude Code sessions in this directory.
|
||||||
|
|
||||||
|
## Incus MCP Server Capabilities
|
||||||
|
|
||||||
|
### Tools (10 available)
|
||||||
|
1. **incus_list_instances**: List all instances with status (supports remote servers)
|
||||||
|
2. **incus_show_instance**: Show detailed instance configuration and state
|
||||||
|
3. **incus_start_instance**: Start stopped instances
|
||||||
|
4. **incus_stop_instance**: Stop running instances (with force option)
|
||||||
|
5. **incus_restart_instance**: Restart instances (with force option)
|
||||||
|
6. **incus_create_instance**: Create new instances from images
|
||||||
|
7. **incus_delete_instance**: Delete instances (with force option)
|
||||||
|
8. **incus_exec_command**: Execute commands inside running instances
|
||||||
|
9. **incus_list_remotes**: List all configured remote servers
|
||||||
|
10. **incus_info**: Show Incus system information
|
||||||
|
|
||||||
|
### Resources (2 available)
|
||||||
|
- **incus://instances/list**: JSON list of all instances across all remotes
|
||||||
|
- **incus://remotes/list**: JSON list of all configured remote servers
|
||||||
|
|
||||||
|
### Remote Server Support
|
||||||
|
The server automatically works with all configured Incus remotes:
|
||||||
|
- **jp1**: Primary remote server (current)
|
||||||
|
- **kr1**: Secondary remote server
|
||||||
|
- **lambda**: Additional remote server
|
||||||
|
- **local**: Local Incus daemon
|
||||||
|
- **images**: LinuxContainers.org image server
|
||||||
|
- **docker**: Docker Hub OCI registry
|
||||||
|
- **ghcr**: GitHub Container Registry
|
||||||
|
|
||||||
|
## Common Operations
|
||||||
|
|
||||||
|
### Development Workflow
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Development mode with auto-reload
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# Build TypeScript to JavaScript
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
# Run the MCP server
|
||||||
|
npm start
|
||||||
|
|
||||||
|
# Run tests
|
||||||
|
node test/simple-test.js
|
||||||
|
node test/resource-test.js
|
||||||
|
```
|
||||||
|
|
||||||
|
### Production Deployment
|
||||||
|
```bash
|
||||||
|
# Build for production
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
# Run the server directly
|
||||||
|
node build/index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration Updates
|
||||||
|
- Modify `src/schemas.ts` to add new tools or resources
|
||||||
|
- Update `src/index.ts` to implement new functionality
|
||||||
|
- Rebuild with `npm run build` after changes
|
||||||
|
- Test with provided test scripts
|
||||||
|
|
||||||
|
## Architecture Notes
|
||||||
|
|
||||||
|
This is a full-featured MCP server implementation with:
|
||||||
|
|
||||||
|
- **Protocol Layer**: Complete MCP protocol implementation using official SDK
|
||||||
|
- **Command Layer**: Safe Incus command execution with proper error handling
|
||||||
|
- **Validation Layer**: Zod schema validation for all tool arguments
|
||||||
|
- **Transport Layer**: Standard stdio transport for MCP communication
|
||||||
|
- **Security Layer**: Input validation and command sanitization
|
||||||
|
|
||||||
|
The server is designed for:
|
||||||
|
- **Local Development**: Direct integration with local Incus daemon
|
||||||
|
- **Remote Management**: Support for multiple Incus remotes
|
||||||
|
- **Production Use**: Robust error handling and logging
|
||||||
|
- **Claude Integration**: Optimized for Claude Code and Claude Desktop
|
||||||
|
|
||||||
|
## Testing and Validation
|
||||||
|
|
||||||
|
The repository includes comprehensive tests:
|
||||||
|
- **Integration Tests**: Full MCP protocol communication tests
|
||||||
|
- **Tool Tests**: Individual tool execution validation
|
||||||
|
- **Resource Tests**: Resource reading and JSON parsing verification
|
||||||
|
- **Error Tests**: Proper error handling for invalid inputs
|
||||||
|
|
||||||
|
All tests validate against real Incus installations with multiple configured remotes.
|
||||||
315
README.md
Normal file
315
README.md
Normal file
@@ -0,0 +1,315 @@
|
|||||||
|
# Incus MCP Server
|
||||||
|
|
||||||
|
A comprehensive Model Context Protocol (MCP) server for managing Incus containers and virtual machines. This server provides a complete set of tools and resources to interact with Incus instances locally and across remote servers through the MCP protocol.
|
||||||
|
|
||||||
|
## ⭐ Key Features
|
||||||
|
|
||||||
|
### 🛠 Tools (10 Available)
|
||||||
|
- **incus_list_instances**: List all instances with their current status (supports remote servers)
|
||||||
|
- **incus_show_instance**: Show detailed information about a specific instance
|
||||||
|
- **incus_start_instance**: Start stopped instances
|
||||||
|
- **incus_stop_instance**: Stop running instances (with optional force flag)
|
||||||
|
- **incus_restart_instance**: Restart instances (with optional force flag)
|
||||||
|
- **incus_create_instance**: Create new instances from images with custom configuration
|
||||||
|
- **incus_delete_instance**: Delete instances (with optional force flag)
|
||||||
|
- **incus_exec_command**: Execute commands inside running instances
|
||||||
|
- **incus_list_remotes**: List all configured remote servers
|
||||||
|
- **incus_info**: Show comprehensive Incus system information
|
||||||
|
|
||||||
|
### 📚 Resources (2 Available)
|
||||||
|
- **incus://instances/list**: JSON list of all instances across all remotes
|
||||||
|
- **incus://remotes/list**: JSON list of all configured remote servers with connection details
|
||||||
|
|
||||||
|
### 🌐 Multi-Remote Support
|
||||||
|
Seamlessly works with all your configured Incus remotes:
|
||||||
|
- **Local instances**: Direct access to local Incus daemon
|
||||||
|
- **Remote servers**: Full support for TLS-authenticated remote Incus servers
|
||||||
|
- **Image sources**: Integration with LinuxContainers.org, Docker Hub, GitHub Container Registry
|
||||||
|
- **Automatic discovery**: Automatically detects and works with existing remote configurations
|
||||||
|
|
||||||
|
## 📋 Prerequisites
|
||||||
|
|
||||||
|
- **Node.js 18+**: Required for running the TypeScript/JavaScript server
|
||||||
|
- **Incus installed**: Working Incus installation with daemon running
|
||||||
|
- **Proper permissions**: User must be in `incus` group or have appropriate file access
|
||||||
|
- **Remote configuration**: Pre-configured remote servers (optional but recommended)
|
||||||
|
|
||||||
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
### Installation from Source
|
||||||
|
```bash
|
||||||
|
# Clone the repository
|
||||||
|
git clone https://github.com/your-username/incus-mcp.git
|
||||||
|
cd incus-mcp
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Build the project
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
# Test the installation
|
||||||
|
npm test
|
||||||
|
```
|
||||||
|
|
||||||
|
### Verify Incus Setup
|
||||||
|
```bash
|
||||||
|
# Check Incus is working
|
||||||
|
incus version
|
||||||
|
incus list
|
||||||
|
incus remote list
|
||||||
|
```
|
||||||
|
|
||||||
|
## 💻 Usage
|
||||||
|
|
||||||
|
### Standalone MCP Server
|
||||||
|
```bash
|
||||||
|
# Run the server directly
|
||||||
|
node build/index.js
|
||||||
|
|
||||||
|
# Development mode with auto-reload
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# Production mode
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integration with Claude Desktop
|
||||||
|
|
||||||
|
Add to your Claude Desktop MCP configuration (`~/.config/claude-desktop/config.json`):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"incus": {
|
||||||
|
"command": "node",
|
||||||
|
"args": ["/absolute/path/to/incus-mcp/build/index.js"],
|
||||||
|
"env": {
|
||||||
|
"PATH": "/usr/local/bin:/opt/homebrew/bin:/usr/bin:/bin"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integration with Claude Code
|
||||||
|
|
||||||
|
The repository includes `.mcp.json` for local development:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"incus": {
|
||||||
|
"command": "node",
|
||||||
|
"args": ["/Users/kaffa/mcp-servers/incus-mcp/build/index.js"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 Development
|
||||||
|
|
||||||
|
### Development Workflow
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Development mode with auto-reload
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# Build TypeScript to JavaScript
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
# Run comprehensive tests
|
||||||
|
node test/simple-test.js
|
||||||
|
node test/resource-test.js
|
||||||
|
|
||||||
|
# Code quality
|
||||||
|
npm run lint
|
||||||
|
npm run format
|
||||||
|
```
|
||||||
|
|
||||||
|
### Project Structure
|
||||||
|
```
|
||||||
|
incus-mcp/
|
||||||
|
├── src/
|
||||||
|
│ ├── index.ts # Main MCP server implementation
|
||||||
|
│ ├── incus.ts # Incus command execution utilities
|
||||||
|
│ └── schemas.ts # MCP tool/resource schema definitions
|
||||||
|
├── test/
|
||||||
|
│ ├── simple-test.js # Basic functionality tests
|
||||||
|
│ └── resource-test.js # Resource reading tests
|
||||||
|
├── build/ # Compiled JavaScript output
|
||||||
|
├── .mcp.json # Local MCP server configuration
|
||||||
|
└── mcp-config-example.json # Claude Desktop config template
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚙️ Configuration
|
||||||
|
|
||||||
|
### System Requirements
|
||||||
|
The server automatically uses your existing Incus configuration:
|
||||||
|
|
||||||
|
1. **Incus daemon running**: `systemctl status incus` (Linux) or check process list
|
||||||
|
2. **User permissions**: Member of `incus` group or appropriate file access
|
||||||
|
3. **Remote servers**: Pre-configured remotes work automatically
|
||||||
|
|
||||||
|
### Setting up Remote Servers
|
||||||
|
```bash
|
||||||
|
# Add a remote Incus server
|
||||||
|
incus remote add myserver https://server.example.com:8443
|
||||||
|
|
||||||
|
# Add with custom certificate
|
||||||
|
incus remote add myserver https://server.example.com:8443 --password
|
||||||
|
|
||||||
|
# List all configured remotes
|
||||||
|
incus remote list
|
||||||
|
|
||||||
|
# Test remote connection
|
||||||
|
incus list myserver:
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
```bash
|
||||||
|
# Optional: Custom PATH for incus binary
|
||||||
|
export PATH="/opt/incus/bin:$PATH"
|
||||||
|
|
||||||
|
# Optional: Debug MCP communication
|
||||||
|
export MCP_DEBUG=1
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📖 Usage Examples
|
||||||
|
|
||||||
|
### Basic Instance Management
|
||||||
|
```bash
|
||||||
|
# Via MCP tools (conceptual - actual usage through MCP client)
|
||||||
|
incus_list_instances: {}
|
||||||
|
# Returns: List of all instances across all remotes
|
||||||
|
|
||||||
|
incus_create_instance: {
|
||||||
|
"name": "webserver",
|
||||||
|
"image": "ubuntu:22.04",
|
||||||
|
"config": {"limits.cpu": "2", "limits.memory": "2GB"}
|
||||||
|
}
|
||||||
|
|
||||||
|
incus_start_instance: {"name": "webserver"}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Remote Operations
|
||||||
|
```bash
|
||||||
|
incus_list_instances: {"remote": "jp1"}
|
||||||
|
# Lists instances only from the jp1 remote server
|
||||||
|
|
||||||
|
incus_show_instance: {"name": "myapp", "remote": "kr1"}
|
||||||
|
# Shows details for 'myapp' instance on kr1 server
|
||||||
|
```
|
||||||
|
|
||||||
|
### Command Execution
|
||||||
|
```bash
|
||||||
|
incus_exec_command: {
|
||||||
|
"instance": "webserver",
|
||||||
|
"command": "apt update && apt install -y nginx",
|
||||||
|
"remote": "jp1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Resource Access
|
||||||
|
- `incus://instances/list` → JSON array of all instances with full metadata
|
||||||
|
- `incus://remotes/list` → JSON object with remote server configurations
|
||||||
|
|
||||||
|
## 🛡️ Security & Error Handling
|
||||||
|
|
||||||
|
### Security Features
|
||||||
|
- **Input validation**: All arguments validated with Zod schemas
|
||||||
|
- **Command sanitization**: No shell injection vulnerabilities
|
||||||
|
- **Permission isolation**: Uses existing Incus user permissions
|
||||||
|
- **Remote auth**: Leverages configured TLS certificates
|
||||||
|
- **Audit trail**: All commands logged through Incus
|
||||||
|
|
||||||
|
### Error Handling
|
||||||
|
- **Graceful failures**: Comprehensive error messages without exposing internals
|
||||||
|
- **Network timeouts**: Proper handling of remote server connectivity issues
|
||||||
|
- **Permission errors**: Clear guidance for permission-related problems
|
||||||
|
- **Invalid arguments**: Detailed validation error messages
|
||||||
|
|
||||||
|
## 🐛 Troubleshooting
|
||||||
|
|
||||||
|
### Common Issues & Solutions
|
||||||
|
|
||||||
|
#### 1. Permission Denied
|
||||||
|
```bash
|
||||||
|
# Add user to incus group
|
||||||
|
sudo usermod -a -G incus $USER
|
||||||
|
newgrp incus
|
||||||
|
|
||||||
|
# Verify permissions
|
||||||
|
id | grep incus
|
||||||
|
incus list # Should work without sudo
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 2. Incus Not Found
|
||||||
|
```bash
|
||||||
|
# Check installation
|
||||||
|
which incus
|
||||||
|
incus version
|
||||||
|
|
||||||
|
# Install on Ubuntu/Debian
|
||||||
|
curl -fsSL https://packagecloud.io/install/repositories/candid/incus/script.deb.sh | sudo bash
|
||||||
|
sudo apt install incus
|
||||||
|
|
||||||
|
# Install on macOS
|
||||||
|
brew install incus
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 3. Remote Connection Issues
|
||||||
|
```bash
|
||||||
|
# Verify remote configuration
|
||||||
|
incus remote list
|
||||||
|
|
||||||
|
# Test connectivity
|
||||||
|
incus info remote-name:
|
||||||
|
|
||||||
|
# Re-add problematic remote
|
||||||
|
incus remote remove old-remote
|
||||||
|
incus remote add old-remote https://server:8443
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 4. MCP Server Issues
|
||||||
|
```bash
|
||||||
|
# Test MCP server directly
|
||||||
|
node build/index.js
|
||||||
|
# Should show: "Incus MCP server running on stdio"
|
||||||
|
|
||||||
|
# Check build output
|
||||||
|
npm run build
|
||||||
|
ls -la build/
|
||||||
|
|
||||||
|
# Run test suite
|
||||||
|
node test/simple-test.js
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debug Mode
|
||||||
|
```bash
|
||||||
|
# Enable verbose logging
|
||||||
|
DEBUG=mcp* node build/index.js
|
||||||
|
|
||||||
|
# Test individual tools
|
||||||
|
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node build/index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🤝 Contributing
|
||||||
|
|
||||||
|
1. Fork the repository
|
||||||
|
2. Create a feature branch: `git checkout -b feature-name`
|
||||||
|
3. Make your changes and add tests
|
||||||
|
4. Run the test suite: `node test/*.js`
|
||||||
|
5. Submit a pull request
|
||||||
|
|
||||||
|
## 📄 License
|
||||||
|
|
||||||
|
MIT License - see LICENSE file for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Built with ❤️ for the Incus and MCP communities**
|
||||||
|
|
||||||
|
For support, please open an issue on GitHub or check the [MCP documentation](https://modelcontextprotocol.io/).
|
||||||
11
mcp-config-example.json
Normal file
11
mcp-config-example.json
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"incus": {
|
||||||
|
"command": "node",
|
||||||
|
"args": ["/Users/kaffa/mcp-servers/incus-mcp/build/index.js"],
|
||||||
|
"env": {
|
||||||
|
"PATH": "/usr/local/bin:/opt/homebrew/bin:/usr/bin:/bin"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
45
package.json
Normal file
45
package.json
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
{
|
||||||
|
"name": "incus-mcp",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "MCP server for Incus container management",
|
||||||
|
"main": "build/index.js",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"build": "tsc",
|
||||||
|
"start": "node build/index.js",
|
||||||
|
"dev": "tsx src/index.ts",
|
||||||
|
"test": "node test/simple-test.js && node test/resource-test.js",
|
||||||
|
"test:basic": "node test/simple-test.js",
|
||||||
|
"test:resources": "node test/resource-test.js",
|
||||||
|
"lint": "eslint src/**/*.ts",
|
||||||
|
"format": "prettier --write src/**/*.ts"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"incus-mcp": "build/index.js"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"mcp",
|
||||||
|
"incus",
|
||||||
|
"containers",
|
||||||
|
"model-context-protocol"
|
||||||
|
],
|
||||||
|
"author": "kaffa",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@modelcontextprotocol/sdk": "^0.6.0",
|
||||||
|
"zod": "^3.23.8"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^20.0.0",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^6.0.0",
|
||||||
|
"@typescript-eslint/parser": "^6.0.0",
|
||||||
|
"eslint": "^8.0.0",
|
||||||
|
"jest": "^29.0.0",
|
||||||
|
"prettier": "^3.0.0",
|
||||||
|
"tsx": "^4.0.0",
|
||||||
|
"typescript": "^5.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
71
src/incus.ts
Normal file
71
src/incus.ts
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
import { spawn } from 'child_process';
|
||||||
|
import { promisify } from 'util';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute an incus command and return the output
|
||||||
|
*/
|
||||||
|
export async function execIncusCommand(args: string[]): Promise<string> {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const child = spawn('incus', args, {
|
||||||
|
stdio: ['ignore', 'pipe', 'pipe'],
|
||||||
|
env: { ...process.env },
|
||||||
|
});
|
||||||
|
|
||||||
|
let stdout = '';
|
||||||
|
let stderr = '';
|
||||||
|
|
||||||
|
child.stdout?.on('data', (data) => {
|
||||||
|
stdout += data.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
child.stderr?.on('data', (data) => {
|
||||||
|
stderr += data.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
child.on('close', (code) => {
|
||||||
|
if (code === 0) {
|
||||||
|
resolve(stdout.trim());
|
||||||
|
} else {
|
||||||
|
reject(new Error(`Incus command failed (exit code ${code}): ${stderr || stdout}`));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
child.on('error', (error) => {
|
||||||
|
reject(new Error(`Failed to execute incus command: ${error.message}`));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parse incus JSON output safely
|
||||||
|
*/
|
||||||
|
export function parseIncusOutput<T = any>(output: string): T {
|
||||||
|
try {
|
||||||
|
return JSON.parse(output);
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`Failed to parse incus output as JSON: ${error}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if incus is available and accessible
|
||||||
|
*/
|
||||||
|
export async function checkIncusAvailability(): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
await execIncusCommand(['version']);
|
||||||
|
return true;
|
||||||
|
} catch (error) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get incus version information
|
||||||
|
*/
|
||||||
|
export async function getIncusVersion(): Promise<string> {
|
||||||
|
try {
|
||||||
|
return await execIncusCommand(['version']);
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`Failed to get incus version: ${error}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
340
src/index.ts
Normal file
340
src/index.ts
Normal file
@@ -0,0 +1,340 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
import { Server } from '@modelcontextprotocol/sdk/server/index.js';
|
||||||
|
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
||||||
|
import {
|
||||||
|
CallToolRequestSchema,
|
||||||
|
ListResourcesRequestSchema,
|
||||||
|
ListToolsRequestSchema,
|
||||||
|
ReadResourceRequestSchema,
|
||||||
|
} from '@modelcontextprotocol/sdk/types.js';
|
||||||
|
import { z } from 'zod';
|
||||||
|
import { execIncusCommand, parseIncusOutput } from './incus.js';
|
||||||
|
import { TOOLS, RESOURCES } from './schemas.js';
|
||||||
|
|
||||||
|
class IncusServer {
|
||||||
|
private server: Server;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
this.server = new Server(
|
||||||
|
{
|
||||||
|
name: 'incus-mcp',
|
||||||
|
version: '0.1.0',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
capabilities: {
|
||||||
|
resources: {},
|
||||||
|
tools: {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
this.setupHandlers();
|
||||||
|
}
|
||||||
|
|
||||||
|
private setupHandlers() {
|
||||||
|
this.server.setRequestHandler(ListResourcesRequestSchema, async () => {
|
||||||
|
return {
|
||||||
|
resources: RESOURCES,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
this.server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
|
||||||
|
const uri = request.params.uri;
|
||||||
|
|
||||||
|
if (uri === 'incus://instances/list') {
|
||||||
|
try {
|
||||||
|
const output = await execIncusCommand(['list', '--format', 'json']);
|
||||||
|
return {
|
||||||
|
contents: [
|
||||||
|
{
|
||||||
|
uri,
|
||||||
|
mimeType: 'application/json',
|
||||||
|
text: output,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`Failed to list instances: ${error}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (uri === 'incus://remotes/list') {
|
||||||
|
try {
|
||||||
|
const output = await execIncusCommand(['remote', 'list', '--format', 'json']);
|
||||||
|
return {
|
||||||
|
contents: [
|
||||||
|
{
|
||||||
|
uri,
|
||||||
|
mimeType: 'application/json',
|
||||||
|
text: output,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`Failed to list remotes: ${error}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new Error(`Unknown resource: ${uri}`);
|
||||||
|
});
|
||||||
|
|
||||||
|
this.server.setRequestHandler(ListToolsRequestSchema, async () => {
|
||||||
|
return { tools: TOOLS };
|
||||||
|
});
|
||||||
|
|
||||||
|
this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
|
||||||
|
const { name, arguments: args } = request.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
switch (name) {
|
||||||
|
case 'incus_list_instances':
|
||||||
|
return await this.listInstances(args);
|
||||||
|
case 'incus_show_instance':
|
||||||
|
return await this.showInstance(args);
|
||||||
|
case 'incus_start_instance':
|
||||||
|
return await this.startInstance(args);
|
||||||
|
case 'incus_stop_instance':
|
||||||
|
return await this.stopInstance(args);
|
||||||
|
case 'incus_restart_instance':
|
||||||
|
return await this.restartInstance(args);
|
||||||
|
case 'incus_create_instance':
|
||||||
|
return await this.createInstance(args);
|
||||||
|
case 'incus_delete_instance':
|
||||||
|
return await this.deleteInstance(args);
|
||||||
|
case 'incus_exec_command':
|
||||||
|
return await this.execCommand(args);
|
||||||
|
case 'incus_list_remotes':
|
||||||
|
return await this.listRemotes(args);
|
||||||
|
case 'incus_info':
|
||||||
|
return await this.getIncusInfo(args);
|
||||||
|
default:
|
||||||
|
throw new Error(`Unknown tool: ${name}`);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Error executing ${name}: ${error instanceof Error ? error.message : String(error)}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
isError: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listInstances(args: any) {
|
||||||
|
const { remote } = z.object({ remote: z.string().optional() }).parse(args);
|
||||||
|
const command = remote ? ['list', '--format', 'json', `${remote}:`] : ['list', '--format', 'json'];
|
||||||
|
|
||||||
|
const output = await execIncusCommand(command);
|
||||||
|
const instances = JSON.parse(output);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Found ${instances.length} instances:\n${JSON.stringify(instances, null, 2)}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async showInstance(args: any) {
|
||||||
|
const { name, remote } = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${name}` : name;
|
||||||
|
const output = await execIncusCommand(['show', instanceName, '--format', 'json']);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Instance details for ${instanceName}:\n${output}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async startInstance(args: any) {
|
||||||
|
const { name, remote } = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${name}` : name;
|
||||||
|
await execIncusCommand(['start', instanceName]);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Started instance: ${instanceName}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async stopInstance(args: any) {
|
||||||
|
const { name, remote, force } = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
force: z.boolean().optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${name}` : name;
|
||||||
|
const command = force ? ['stop', instanceName, '--force'] : ['stop', instanceName];
|
||||||
|
await execIncusCommand(command);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Stopped instance: ${instanceName}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async restartInstance(args: any) {
|
||||||
|
const { name, remote, force } = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
force: z.boolean().optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${name}` : name;
|
||||||
|
const command = force ? ['restart', instanceName, '--force'] : ['restart', instanceName];
|
||||||
|
await execIncusCommand(command);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Restarted instance: ${instanceName}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async createInstance(args: any) {
|
||||||
|
const { name, image, remote, config } = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
image: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
config: z.record(z.string()).optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${name}` : name;
|
||||||
|
const command = ['create', image, instanceName];
|
||||||
|
|
||||||
|
// Add config options if provided
|
||||||
|
if (config) {
|
||||||
|
for (const [key, value] of Object.entries(config)) {
|
||||||
|
command.push('-c', `${key}=${value}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await execIncusCommand(command);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Created instance: ${instanceName} from image: ${image}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async deleteInstance(args: any) {
|
||||||
|
const { name, remote, force } = z.object({
|
||||||
|
name: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
force: z.boolean().optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${name}` : name;
|
||||||
|
const command = force ? ['delete', instanceName, '--force'] : ['delete', instanceName];
|
||||||
|
await execIncusCommand(command);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Deleted instance: ${instanceName}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async execCommand(args: any) {
|
||||||
|
const { instance, command, remote } = z.object({
|
||||||
|
instance: z.string(),
|
||||||
|
command: z.string(),
|
||||||
|
remote: z.string().optional(),
|
||||||
|
}).parse(args);
|
||||||
|
|
||||||
|
const instanceName = remote ? `${remote}:${instance}` : instance;
|
||||||
|
const output = await execIncusCommand(['exec', instanceName, '--', 'sh', '-c', command]);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Command output from ${instanceName}:\n${output}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async listRemotes(args: any) {
|
||||||
|
const output = await execIncusCommand(['remote', 'list', '--format', 'json']);
|
||||||
|
const remotes = JSON.parse(output);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Available remotes:\n${JSON.stringify(remotes, null, 2)}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getIncusInfo(args: any) {
|
||||||
|
const output = await execIncusCommand(['info']);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: `Incus system information:\n${output}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async run() {
|
||||||
|
const transport = new StdioServerTransport();
|
||||||
|
await this.server.connect(transport);
|
||||||
|
console.error('Incus MCP server running on stdio');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const server = new IncusServer();
|
||||||
|
await server.run();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
||||||
|
main().catch((error) => {
|
||||||
|
console.error('Server error:', error);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
|
}
|
||||||
204
src/schemas.ts
Normal file
204
src/schemas.ts
Normal file
@@ -0,0 +1,204 @@
|
|||||||
|
import { Tool, Resource } from '@modelcontextprotocol/sdk/types.js';
|
||||||
|
|
||||||
|
export const TOOLS: Tool[] = [
|
||||||
|
{
|
||||||
|
name: 'incus_list_instances',
|
||||||
|
description: 'List all incus instances with their current status',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional, defaults to local)',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_show_instance',
|
||||||
|
description: 'Show detailed information about a specific incus instance',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
name: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name of the instance to show',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['name'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_start_instance',
|
||||||
|
description: 'Start an incus instance',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
name: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name of the instance to start',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['name'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_stop_instance',
|
||||||
|
description: 'Stop an incus instance',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
name: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name of the instance to stop',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
force: {
|
||||||
|
type: 'boolean',
|
||||||
|
description: 'Force stop the instance (optional)',
|
||||||
|
default: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['name'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_restart_instance',
|
||||||
|
description: 'Restart an incus instance',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
name: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name of the instance to restart',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
force: {
|
||||||
|
type: 'boolean',
|
||||||
|
description: 'Force restart the instance (optional)',
|
||||||
|
default: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['name'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_create_instance',
|
||||||
|
description: 'Create a new incus instance from an image',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
name: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name for the new instance',
|
||||||
|
},
|
||||||
|
image: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Image to create the instance from (e.g., ubuntu:22.04)',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
config: {
|
||||||
|
type: 'object',
|
||||||
|
description: 'Configuration options for the instance (optional)',
|
||||||
|
additionalProperties: {
|
||||||
|
type: 'string',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['name', 'image'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_delete_instance',
|
||||||
|
description: 'Delete an incus instance',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
name: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name of the instance to delete',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
force: {
|
||||||
|
type: 'boolean',
|
||||||
|
description: 'Force delete the instance (optional)',
|
||||||
|
default: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['name'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_exec_command',
|
||||||
|
description: 'Execute a command inside an incus instance',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
instance: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Name of the instance to execute command in',
|
||||||
|
},
|
||||||
|
command: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Command to execute',
|
||||||
|
},
|
||||||
|
remote: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'Remote server name (optional)',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: ['instance', 'command'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_list_remotes',
|
||||||
|
description: 'List all configured incus remote servers',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'incus_info',
|
||||||
|
description: 'Show incus system information',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
export const RESOURCES: Resource[] = [
|
||||||
|
{
|
||||||
|
uri: 'incus://instances/list',
|
||||||
|
name: 'Incus Instances List',
|
||||||
|
description: 'List of all incus instances',
|
||||||
|
mimeType: 'application/json',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
uri: 'incus://remotes/list',
|
||||||
|
name: 'Incus Remotes List',
|
||||||
|
description: 'List of all configured incus remote servers',
|
||||||
|
mimeType: 'application/json',
|
||||||
|
},
|
||||||
|
];
|
||||||
169
test/client.ts
Normal file
169
test/client.ts
Normal file
@@ -0,0 +1,169 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
|
||||||
|
import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
|
||||||
|
import { spawn } from 'child_process';
|
||||||
|
|
||||||
|
class TestClient {
|
||||||
|
private client: Client;
|
||||||
|
private transport: StdioClientTransport;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
// Spawn the MCP server process
|
||||||
|
const serverProcess = spawn('node', ['../build/index.js'], {
|
||||||
|
stdio: ['pipe', 'pipe', 'inherit'],
|
||||||
|
cwd: __dirname,
|
||||||
|
});
|
||||||
|
|
||||||
|
this.transport = new StdioClientTransport({
|
||||||
|
reader: serverProcess.stdout!,
|
||||||
|
writer: serverProcess.stdin!,
|
||||||
|
});
|
||||||
|
|
||||||
|
this.client = new Client(
|
||||||
|
{
|
||||||
|
name: 'incus-mcp-test-client',
|
||||||
|
version: '0.1.0',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
capabilities: {},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async connect() {
|
||||||
|
await this.client.connect(this.transport);
|
||||||
|
console.log('✅ Connected to Incus MCP server');
|
||||||
|
}
|
||||||
|
|
||||||
|
async testListTools() {
|
||||||
|
console.log('\n🔧 Testing list tools...');
|
||||||
|
try {
|
||||||
|
const result = await this.client.request(
|
||||||
|
{ method: 'tools/list' },
|
||||||
|
{ method: 'tools/list' }
|
||||||
|
);
|
||||||
|
console.log(`Found ${result.tools.length} tools:`);
|
||||||
|
result.tools.forEach((tool: any) => {
|
||||||
|
console.log(` - ${tool.name}: ${tool.description}`);
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Error listing tools:', error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async testListResources() {
|
||||||
|
console.log('\n📚 Testing list resources...');
|
||||||
|
try {
|
||||||
|
const result = await this.client.request(
|
||||||
|
{ method: 'resources/list' },
|
||||||
|
{ method: 'resources/list' }
|
||||||
|
);
|
||||||
|
console.log(`Found ${result.resources.length} resources:`);
|
||||||
|
result.resources.forEach((resource: any) => {
|
||||||
|
console.log(` - ${resource.uri}: ${resource.name}`);
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Error listing resources:', error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async testIncusInfo() {
|
||||||
|
console.log('\n💻 Testing incus info...');
|
||||||
|
try {
|
||||||
|
const result = await this.client.request(
|
||||||
|
{
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_info',
|
||||||
|
arguments: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_info',
|
||||||
|
arguments: {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
console.log('Incus info result:', result);
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Error getting incus info:', error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async testListInstances() {
|
||||||
|
console.log('\n📦 Testing list instances...');
|
||||||
|
try {
|
||||||
|
const result = await this.client.request(
|
||||||
|
{
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_list_instances',
|
||||||
|
arguments: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_list_instances',
|
||||||
|
arguments: {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
console.log('Instances list result:', result);
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Error listing instances:', error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async testListRemotes() {
|
||||||
|
console.log('\n🌐 Testing list remotes...');
|
||||||
|
try {
|
||||||
|
const result = await this.client.request(
|
||||||
|
{
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_list_remotes',
|
||||||
|
arguments: {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_list_remotes',
|
||||||
|
arguments: {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
);
|
||||||
|
console.log('Remotes list result:', result);
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Error listing remotes:', error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async runTests() {
|
||||||
|
try {
|
||||||
|
await this.connect();
|
||||||
|
await this.testListTools();
|
||||||
|
await this.testListResources();
|
||||||
|
await this.testIncusInfo();
|
||||||
|
await this.testListInstances();
|
||||||
|
await this.testListRemotes();
|
||||||
|
console.log('\n✅ All tests completed');
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Test failed:', error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run tests
|
||||||
|
async function main() {
|
||||||
|
const testClient = new TestClient();
|
||||||
|
await testClient.runTests();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
||||||
|
main().catch(console.error);
|
||||||
|
}
|
||||||
164
test/resource-test.js
Normal file
164
test/resource-test.js
Normal file
@@ -0,0 +1,164 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
import { spawn } from 'child_process';
|
||||||
|
|
||||||
|
async function testResources() {
|
||||||
|
console.log('🔍 Testing MCP Resources...\n');
|
||||||
|
|
||||||
|
// Test reading instances list resource
|
||||||
|
console.log('1. Testing incus://instances/list resource...');
|
||||||
|
const instancesResourceMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 1,
|
||||||
|
method: 'resources/read',
|
||||||
|
params: {
|
||||||
|
uri: 'incus://instances/list'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const result = await sendMCPRequest(instancesResourceMessage);
|
||||||
|
console.log(` ✅ Resource read successful`);
|
||||||
|
if (result.contents && result.contents[0]) {
|
||||||
|
const content = result.contents[0];
|
||||||
|
console.log(` URI: ${content.uri}`);
|
||||||
|
console.log(` MIME Type: ${content.mimeType}`);
|
||||||
|
console.log(` Content length: ${content.text.length} chars`);
|
||||||
|
|
||||||
|
// Try to parse as JSON
|
||||||
|
try {
|
||||||
|
const instances = JSON.parse(content.text);
|
||||||
|
console.log(` Found ${instances.length} instances in JSON format`);
|
||||||
|
} catch (e) {
|
||||||
|
console.log(` Content is not JSON: ${e.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test reading remotes list resource
|
||||||
|
console.log('\n2. Testing incus://remotes/list resource...');
|
||||||
|
const remotesResourceMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 2,
|
||||||
|
method: 'resources/read',
|
||||||
|
params: {
|
||||||
|
uri: 'incus://remotes/list'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const result = await sendMCPRequest(remotesResourceMessage);
|
||||||
|
console.log(` ✅ Resource read successful`);
|
||||||
|
if (result.contents && result.contents[0]) {
|
||||||
|
const content = result.contents[0];
|
||||||
|
console.log(` URI: ${content.uri}`);
|
||||||
|
console.log(` MIME Type: ${content.mimeType}`);
|
||||||
|
console.log(` Content length: ${content.text.length} chars`);
|
||||||
|
|
||||||
|
// Try to parse as JSON
|
||||||
|
try {
|
||||||
|
const remotes = JSON.parse(content.text);
|
||||||
|
const remoteNames = Object.keys(remotes);
|
||||||
|
console.log(` Found ${remoteNames.length} remotes: ${remoteNames.join(', ')}`);
|
||||||
|
} catch (e) {
|
||||||
|
console.log(` Content is not JSON: ${e.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test reading unknown resource
|
||||||
|
console.log('\n3. Testing unknown resource...');
|
||||||
|
const unknownResourceMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 3,
|
||||||
|
method: 'resources/read',
|
||||||
|
params: {
|
||||||
|
uri: 'incus://unknown/resource'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const result = await sendMCPRequest(unknownResourceMessage);
|
||||||
|
console.log(` ❌ Unexpected success: ${JSON.stringify(result)}`);
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ✅ Expected error: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function sendMCPRequest(message) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const serverProcess = spawn('node', ['build/index.js'], {
|
||||||
|
stdio: ['pipe', 'pipe', 'pipe']
|
||||||
|
});
|
||||||
|
|
||||||
|
let response = '';
|
||||||
|
let error = '';
|
||||||
|
|
||||||
|
serverProcess.stdout.on('data', (data) => {
|
||||||
|
response += data.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
serverProcess.stderr.on('data', (data) => {
|
||||||
|
error += data.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
serverProcess.on('close', (code) => {
|
||||||
|
if (code !== 0) {
|
||||||
|
reject(new Error(`Server exited with code ${code}: ${error}`));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Parse JSON-RPC response
|
||||||
|
const lines = response.trim().split('\n');
|
||||||
|
let jsonResponse = null;
|
||||||
|
|
||||||
|
for (const line of lines) {
|
||||||
|
if (line.trim()) {
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(line);
|
||||||
|
if (parsed.id === message.id) {
|
||||||
|
jsonResponse = parsed;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
// Skip non-JSON lines
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (jsonResponse) {
|
||||||
|
if (jsonResponse.error) {
|
||||||
|
reject(new Error(jsonResponse.error.message || 'Unknown error'));
|
||||||
|
} else {
|
||||||
|
resolve(jsonResponse.result);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
reject(new Error(`No valid response found in: ${response}`));
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
reject(new Error(`Failed to parse response: ${e.message}\nResponse: ${response}`));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
serverProcess.on('error', (err) => {
|
||||||
|
reject(new Error(`Failed to start server: ${err.message}`));
|
||||||
|
});
|
||||||
|
|
||||||
|
// Send the JSON-RPC message
|
||||||
|
serverProcess.stdin.write(JSON.stringify(message) + '\n');
|
||||||
|
serverProcess.stdin.end();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run resource tests
|
||||||
|
testResources().then(() => {
|
||||||
|
console.log('\n✅ All resource tests completed!');
|
||||||
|
}).catch((error) => {
|
||||||
|
console.error('\n❌ Resource test suite failed:', error);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
187
test/simple-test.js
Normal file
187
test/simple-test.js
Normal file
@@ -0,0 +1,187 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
import { spawn } from 'child_process';
|
||||||
|
import { promises as fs } from 'fs';
|
||||||
|
|
||||||
|
// Simple MCP client test
|
||||||
|
async function testMCPServer() {
|
||||||
|
console.log('🧪 Testing Incus MCP Server...\n');
|
||||||
|
|
||||||
|
// Test 1: List tools
|
||||||
|
console.log('1. Testing list tools...');
|
||||||
|
const listToolsMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 1,
|
||||||
|
method: 'tools/list',
|
||||||
|
params: {}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const toolsResult = await sendMCPRequest(listToolsMessage);
|
||||||
|
console.log(` ✅ Found ${toolsResult.tools.length} tools`);
|
||||||
|
toolsResult.tools.forEach(tool => {
|
||||||
|
console.log(` - ${tool.name}`);
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test 2: List resources
|
||||||
|
console.log('\n2. Testing list resources...');
|
||||||
|
const listResourcesMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 2,
|
||||||
|
method: 'resources/list',
|
||||||
|
params: {}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const resourcesResult = await sendMCPRequest(listResourcesMessage);
|
||||||
|
console.log(` ✅ Found ${resourcesResult.resources.length} resources`);
|
||||||
|
resourcesResult.resources.forEach(resource => {
|
||||||
|
console.log(` - ${resource.uri}: ${resource.name}`);
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test 3: Test incus info tool
|
||||||
|
console.log('\n3. Testing incus_info tool...');
|
||||||
|
const infoMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 3,
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_info',
|
||||||
|
arguments: {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const infoResult = await sendMCPRequest(infoMessage);
|
||||||
|
console.log(` ✅ Got incus info`);
|
||||||
|
if (infoResult.content && infoResult.content[0]) {
|
||||||
|
console.log(` First few chars: ${infoResult.content[0].text.substring(0, 100)}...`);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test 4: Test list instances
|
||||||
|
console.log('\n4. Testing incus_list_instances tool...');
|
||||||
|
const listInstancesMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 4,
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_list_instances',
|
||||||
|
arguments: {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const instancesResult = await sendMCPRequest(listInstancesMessage);
|
||||||
|
console.log(` ✅ Got instances list`);
|
||||||
|
if (instancesResult.content && instancesResult.content[0]) {
|
||||||
|
console.log(` Response: ${instancesResult.content[0].text.substring(0, 200)}...`);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Test 5: Test list remotes
|
||||||
|
console.log('\n5. Testing incus_list_remotes tool...');
|
||||||
|
const listRemotesMessage = {
|
||||||
|
jsonrpc: '2.0',
|
||||||
|
id: 5,
|
||||||
|
method: 'tools/call',
|
||||||
|
params: {
|
||||||
|
name: 'incus_list_remotes',
|
||||||
|
arguments: {}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const remotesResult = await sendMCPRequest(listRemotesMessage);
|
||||||
|
console.log(` ✅ Got remotes list`);
|
||||||
|
if (remotesResult.content && remotesResult.content[0]) {
|
||||||
|
console.log(` Response: ${remotesResult.content[0].text.substring(0, 200)}...`);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.log(` ❌ Error: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function sendMCPRequest(message) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const serverProcess = spawn('node', ['build/index.js'], {
|
||||||
|
stdio: ['pipe', 'pipe', 'pipe']
|
||||||
|
});
|
||||||
|
|
||||||
|
let response = '';
|
||||||
|
let error = '';
|
||||||
|
|
||||||
|
serverProcess.stdout.on('data', (data) => {
|
||||||
|
response += data.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
serverProcess.stderr.on('data', (data) => {
|
||||||
|
error += data.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
serverProcess.on('close', (code) => {
|
||||||
|
if (code !== 0) {
|
||||||
|
reject(new Error(`Server exited with code ${code}: ${error}`));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Parse JSON-RPC response
|
||||||
|
const lines = response.trim().split('\n');
|
||||||
|
let jsonResponse = null;
|
||||||
|
|
||||||
|
for (const line of lines) {
|
||||||
|
if (line.trim()) {
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(line);
|
||||||
|
if (parsed.id === message.id) {
|
||||||
|
jsonResponse = parsed;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
// Skip non-JSON lines
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (jsonResponse) {
|
||||||
|
if (jsonResponse.error) {
|
||||||
|
reject(new Error(jsonResponse.error.message || 'Unknown error'));
|
||||||
|
} else {
|
||||||
|
resolve(jsonResponse.result);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
reject(new Error(`No valid response found in: ${response}`));
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
reject(new Error(`Failed to parse response: ${e.message}\nResponse: ${response}`));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
serverProcess.on('error', (err) => {
|
||||||
|
reject(new Error(`Failed to start server: ${err.message}`));
|
||||||
|
});
|
||||||
|
|
||||||
|
// Send the JSON-RPC message
|
||||||
|
serverProcess.stdin.write(JSON.stringify(message) + '\n');
|
||||||
|
serverProcess.stdin.end();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run tests
|
||||||
|
testMCPServer().then(() => {
|
||||||
|
console.log('\n✅ All tests completed!');
|
||||||
|
}).catch((error) => {
|
||||||
|
console.error('\n❌ Test suite failed:', error);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
20
tsconfig.json
Normal file
20
tsconfig.json
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "node",
|
||||||
|
"strict": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"forceConsistentCasingInFileNames": true,
|
||||||
|
"outDir": "./build",
|
||||||
|
"rootDir": "./src",
|
||||||
|
"declaration": true,
|
||||||
|
"declarationMap": true,
|
||||||
|
"sourceMap": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"allowSyntheticDefaultImports": true
|
||||||
|
},
|
||||||
|
"include": ["src/**/*"],
|
||||||
|
"exclude": ["node_modules", "build", "**/*.test.ts"]
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user