Skip to main content

Development Guide

This guide provides instructions for developing and contributing to the CWCloud MCP Server.

Project Structure​

cwcloud-mcp/
├── cmd/server/                 # Application entry point
│   └── main.go                # Main application bootstrap
├── internal/                  # Internal application code (private)
│   ├── types/                 # CENTRALIZED TYPE DEFINITIONS
│   │   └── types.go          # All project types in one place
│   ├── config/                # Configuration management
│   │   └── config.go         # Environment and config loading
│   ├── cwapi/                 # CWCloud API client
│   │   ├── client.go         # HTTP client implementation
│   │   └── auth.go           # Authentication logic
│   ├── mcp/                   # MCP protocol implementation
│   │   ├── server.go         # MCP server core
│   │   ├── handlers.go       # Message handlers
│   │   ├── tools.go          # Tool constructors
│   │   └── errors.go         # Error handling
│   └── tools/                 # MCP tool implementations
│       ├── generate_ai_prompt.go  # AI generation tool
│       └── list_conversations.go # Conversation management tool
├── pkg/                       # PUBLIC PACKAGES (importable by other Go projects)
│   └── mcp/                   # Public CWCloud MCP library
│       ├── client.go          # Public client interface
│       ├── types.go           # Public type definitions
│       ├── tools.go           # MCP tool helpers
│       └── README.md          # Library documentation
├── examples/                  # USAGE EXAMPLES
│   └── usage.go              # Complete usage examples
└── docs/                      # Documentation

Building from Source​

# Install dependencies
go mod tidy

# Build for production
go build -ldflags="-w -s" -o cwcloud-mcp ./cmd/server

# Build Docker image
make docker
# or manually:
docker build -t cwcloud-mcp .

Running Tests​

Integration test​

# Interactive tests with AI functionality (requires valid API keys)
./test-interactive.sh

# Or you can do the same thing using the Make commands
make test-interactive # Run interactive AI tests

Unit tests​

# Note: Unit tests will be added as the project matures

# Run tests
go test ./...

# Or you can do the same thing using the Make commands
make test

Troubleshooting​

Debug Mode​

Enable debug logging for detailed troubleshooting:

LOG_LEVEL=debug