mcp-openapi-generator 1.0.0__tar.gz

mcp_openapi_generator-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+build/
+dist/
+generated/
+.vscode/mcp.json

mcp_openapi_generator-1.0.0/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "git.ignoreLimitWarning": true,
+    "chat.restoreLastPanelSession": true
+}

mcp_openapi_generator-1.0.0/Dockerfile

@@ -0,0 +1,58 @@
+# Multi-stage build for MCP OpenAPI Generator
+# Stage 1: Build dependencies
+FROM python:3.11-slim AS builder
+
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    curl \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install UV for fast package management
+RUN pip install --no-cache-dir uv
+
+# Copy project files
+COPY pyproject.toml README.md ./
+COPY src/ ./src/
+
+# Install package in editable mode
+RUN uv pip install --system -e .
+
+# Stage 2: Runtime with generators
+FROM python:3.11-slim AS runtime
+
+WORKDIR /app
+
+# Install system dependencies including OpenAPI generators
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    openjdk-17-jre-headless \
+    curl \
+    git \
+    npm \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install openapi-generator-cli and swagger-codegen via npm
+RUN npm install -g @openapitools/openapi-generator-cli swagger-codegen
+
+# Install validation tools
+RUN npm install -g @stoplight/spectral-cli vacuum
+
+# Copy Python package from builder
+COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+
+# Copy source code
+COPY src/ ./src/
+
+# Create non-root user
+RUN useradd --create-home --shell /bin/bash mcp
+USER mcp
+
+# Set working directory
+WORKDIR /home/mcp
+
+# Default command
+ENTRYPOINT ["python", "-m", "mcp_openapi_generator.server"]

mcp_openapi_generator-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 M.K. Abdullahi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcp_openapi_generator-1.0.0/PKG-INFO

@@ -0,0 +1,332 @@
+Metadata-Version: 2.5
+Name: mcp-openapi-generator
+Version: 1.0.0
+Summary: MCP server for OpenAPI code generation (openapi-generator, swagger-codegen) and validation (Spectral, Vacuum)
+Project-URL: Homepage, https://github.com/mkabdullahi/mcp-openapi-generator
+Project-URL: Repository, https://github.com/mkabdullahi/mcp-openapi-generator
+Project-URL: Issues, https://github.com/mkabdullahi/mcp-openapi-generator/issues
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: rich>=13.7.0
+Requires-Dist: tenacity>=8.3.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.2.0; extra == 'dev'
+Requires-Dist: ruff>=0.5.0; extra == 'dev'
+Provides-Extra: smithery
+Requires-Dist: docker>=7.0.0; extra == 'smithery'
+Description-Content-Type: text/markdown
+
+# MCP OpenAPI Generator
+
+[![PyPI version](https://img.shields.io/pypi/v/mcp-openapi-generator.svg)](https://pypi.org/project/mcp-openapi-generator/)
+[![Python Version](https://img.shields.io/pypi/pyversions/mcp-openapi-generator.svg)](https://pypi.org/project/mcp-openapi-generator/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Smithery](https://img.shields.io/badge/Smithery-registered-blue.svg)](https://smithery.ai)
+
+An **MCP (Model Context Protocol) server** that provides OpenAPI code generation and validation capabilities to AI assistants. Wraps industry-standard tools:
+
+- **Code Generation**: `openapi-generator` and `swagger-codegen` for 50+ target languages/frameworks
+- **Validation**: `Spectral` and `Vacuum` for OpenAPI specification linting
+- **Project Intelligence**: Auto-detects project type and suggests appropriate targets
+
+## Features
+
+| Capability | Tools | Description |
+|------------|-------|-------------|
+| **Generate Client** | openapi-generator, swagger-codegen | Generate SDKs for TypeScript, Python, Java, Go, Rust, Swift, C#, Kotlin, and more |
+| **Validate Spec** | Spectral, Vacuum | Lint OpenAPI specs with customizable rulesets |
+| **List Generators** | — | Discover available generators and targets |
+| **Infer Project** | — | Auto-detect project type (Node, Python, Rust, Go, Java, etc.) and suggest targets |
+
+## Quick Start
+
+### Installation
+
+```bash
+# Via pip (recommended)
+pip install mcp-openapi-generator
+
+# Or via Smithery (for MCP clients)
+smithery install @mkabdullahi/mcp-openapi-generator
+```
+
+### Usage as MCP Server
+
+Configure in your MCP client (Claude Desktop, Cursor, etc.):
+
+```json
+{
+  "mcpServers": {
+    "openapi-generator": {
+      "command": "python",
+      "args": ["-m", "mcp_openapi_generator.server"]
+    }
+  }
+}
+```
+
+For a local VS Code setup, create `.vscode/mcp.json` with the following
+configuration after creating and installing into the project virtual
+environment:
+
+```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install -e .
+```
+
+```json
+{
+  "servers": {
+    "openapi-generator": {
+      "type": "stdio",
+      "command": "${workspaceFolder}/.venv/bin/python",
+      "args": ["-m", "mcp_openapi_generator.server"],
+      "cwd": "${workspaceFolder}"
+    }
+  }
+}
+```
+
+In VS Code, open the MCP server controls and start `openapi-generator`. This
+workspace configuration is ignored by Git because it points to a local virtual
+environment.
+
+### Usage as CLI Tool
+
+```bash
+# Generate TypeScript client from Petstore
+mcp-openapi-generator generate https://petstore.swagger.io/v2/swagger.json \
+  --target typescript-axios \
+  --output ./petstore-client
+
+# Validate a spec
+mcp-openapi-generator validate https://petstore.swagger.io/v2/swagger.json
+
+# List available generators
+mcp-openapi-generator generators
+
+# Infer project config
+mcp-openapi-generator infer
+```
+
+## Available Tools (MCP)
+
+| Tool | Description | Parameters |
+|------|-------------|------------|
+| `generate-client` | Generate client code from OpenAPI spec | `spec`, `target`, `output_dir`, `package_name`, `package_version`, `additional_properties`, `generate_tests`, `post_process` |
+| `validate-spec` | Validate OpenAPI specification | `spec`, `tool` (spectral/vacuum), `ruleset`, `fail_on_warnings` |
+| `list-generators` | List available generators and targets | — |
+| `infer-project` | Detect project type and suggest target | — |
+
+### Tool: generate-client
+
+```json
+{
+  "spec": {
+    "source": "url",
+    "location": "https://api.example.com/openapi.yaml",
+    "format": "yaml"
+  },
+  "target": "typescript-axios",
+  "output_dir": "./generated",
+  "package_name": "my-api-client",
+  "package_version": "1.0.0",
+  "additional_properties": {
+    "supportsES6": "true",
+    "npmName": "@myorg/api-client"
+  },
+  "generate_tests": true,
+  "post_process": true
+}
+```
+
+### Tool: validate-spec
+
+```json
+{
+  "spec": {
+    "source": "file",
+    "location": "./openapi.yaml"
+  },
+  "tool": "spectral",
+  "ruleset": "spectral:oas",
+  "fail_on_warnings": false
+}
+```
+
+## Supported Targets
+
+| Category | Targets |
+|----------|---------|
+| **TypeScript** | `typescript-axios`, `typescript-fetch`, `typescript-node` |
+| **Python** | `python`, `python-aiohttp` |
+| **Java** | `spring`, `spring-boot` |
+| **Kotlin** | `kotlin-spring` |
+| **Go** | `go`, `go-gin` |
+| **Rust** | `rust` |
+| **Swift** | `swift5` |
+| **C#** | `csharp-netcore` |
+
+Run `mcp-openapi-generator generators` for the full list (depends on installed generators).
+
+## Prerequisites
+
+The server wraps external CLI tools. Install them for full functionality:
+
+```bash
+# Code generators (choose one or both)
+npm install -g @openapitools/openapi-generator-cli
+npm install -g swagger-codegen
+
+# Validators
+npm install -g @stoplight/spectral-cli
+npm install -g vacuum
+```
+
+Or use the Docker image which includes everything:
+
+```bash
+docker run --rm -v $(pwd):/workspace ghcr.io/mkabdullahi/mcp-openapi-generator generate ...
+```
+
+## Configuration
+
+### Project Auto-Detection
+
+The server automatically detects your project type:
+
+| File | Detected As |
+|------|-------------|
+| `package.json` | TypeScript/JavaScript |
+| `pyproject.toml` / `requirements.txt` | Python |
+| `Cargo.toml` | Rust |
+| `go.mod` | Go |
+| `pom.xml` / `build.gradle` | Java/Kotlin |
+
+### Default Targets by Language
+
+| Language | Default Target |
+|----------|----------------|
+| TypeScript | `typescript-axios` |
+| Python | `python` |
+| Java | `spring-boot` |
+| Kotlin | `kotlin-spring` |
+| Go | `go-gin` |
+| Rust | `rust` |
+| Swift | `swift5` |
+| C# | `csharp-netcore` |
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/mkabdullahi/mcp-openapi-generator
+cd mcp-openapi-generator
+
+# Create virtual environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=mcp_openapi_generator --cov-report=html
+
+# Run only unit tests (skip integration)
+pytest -m "not integration"
+```
+
+### Code Quality
+
+```bash
+# Format
+ruff format .
+
+# Lint
+ruff check .
+
+# Type check
+mypy src/
+```
+
+## Publishing
+
+### To PyPI
+
+```bash
+# Build
+python -m build
+
+# Publish
+twine upload dist/*
+```
+
+### To Smithery
+
+```bash
+# Build Docker image
+docker build -t ghcr.io/mkabdullahi/mcp-openapi-generator:latest .
+
+# Push
+docker push ghcr.io/mkabdullahi/mcp-openapi-generator:latest
+
+# Publish to Smithery
+smithery publish
+```
+
+## Architecture
+
+```
+mcp_openapi_generator/
+├── server.py          # MCP server implementation
+├── cli.py             # CLI entry points
+├── tools/
+│   ├── generate.py    # Code generation wrapper
+│   └── validate.py    # Validation wrapper
+├── utils/
+│   ├── config_inference.py  # Project type detection
+│   ├── spec_resolver.py     # Spec fetching & resolution
+│   └── post_process.py      # Formatting & test stubs
+└── types/
+    └── __init__.py    # Type definitions (dataclasses, enums)
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linting
+5. Submit a PR
+
+## Related
+
+- [Model Context Protocol](https://modelcontextprotocol.io/)
+- [OpenAPI Generator](https://openapi-generator.tech/)
+- [Spectral](https://meta.stoplight.io/spectral/)
+- [Vacuum](https://github.com/daveshanley/vacuum)