closes #4 Refactor codebase into a modular structure with backward compatibility by abutbul · Pull Request #8 · abutbul/openapi-mcp-generator

abutbul · 2025-05-23T19:05:26Z

Updated .gitignore to exclude build artifacts and cache files.
Created MANIFEST.in to include necessary files in the package.
Added MODULAR_REFACTORING.md to document the refactoring process.
Enhanced README.md to reflect the new modular design and usage instructions.
Introduced compatibility_example.py to demonstrate usage of both original and modular approaches.
Added programmatic_usage.py to showcase how to use the package programmatically.
Updated generator.py to support modular imports and fallback to original implementation.
Created mcp_generator.py as a new entry point for the modular structure.
Established init.py to define the package interface.
Developed cli.py for command-line interface functionality.
Implemented generator.py for core generation logic.
Added generators.py for generating tool and resource definitions.
Created http.py for HTTP client utilities.
Developed parser.py for parsing OpenAPI specifications.
Introduced project.py for project directory and file management.
Updated pyproject.toml for package metadata and dependencies.
Created setup.py for package installation.

- Updated .gitignore to exclude build artifacts and cache files. - Created MANIFEST.in to include necessary files in the package. - Added MODULAR_REFACTORING.md to document the refactoring process. - Enhanced README.md to reflect the new modular design and usage instructions. - Introduced compatibility_example.py to demonstrate usage of both original and modular approaches. - Added programmatic_usage.py to showcase how to use the package programmatically. - Updated generator.py to support modular imports and fallback to original implementation. - Created mcp_generator.py as a new entry point for the modular structure. - Established __init__.py to define the package interface. - Developed cli.py for command-line interface functionality. - Implemented generator.py for core generation logic. - Added generators.py for generating tool and resource definitions. - Created http.py for HTTP client utilities. - Developed parser.py for parsing OpenAPI specifications. - Introduced project.py for project directory and file management. - Updated pyproject.toml for package metadata and dependencies. - Created setup.py for package installation.

Copilot

Pull Request Overview

This PR refactors the codebase into a modular Python package while maintaining backward compatibility. Key changes include new package structure and entry points, updated build configuration files, and enhanced documentation reflecting these changes.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
setup.py, pyproject.toml, MANIFEST.in	New and updated packaging files for package installation
openapi_mcp_generator/*	Modular reorganization of core functionality into a package
generator.py, mcp_generator.py, cli.py	New and alternative entry points with CLI improvements and fallbacks
README.md, MODULAR_REFACTORING.md	Updated documentation and usage instructions reflecting modular design
examples/*	Examples updated to showcase multiple usage methods

openapi_mcp_generator/cli.py

…ver output

…nfiguration

great suggestion. missed out on that Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull Request Overview

Refactors the project into a modular Python package while preserving the original script-based workflow for backward compatibility.

Introduces openapi_mcp_generator package with separated modules (CLI, generator, parser, HTTP utils, project builder).
Adds new entry point (mcp_generator.py) alongside the original generator.py to support both workflows.
Updates packaging (setup.py, pyproject.toml, MANIFEST.in), documentation (README.md, MODULAR_REFACTORING.md), and CI to install and test the package.

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
generator.py	Kept original CLI script and added fallback to modular implementation
mcp_generator.py	New wrapper entry point invoking the modular CLI
openapi_mcp_generator/generator.py	Core modular generation logic and template context creator
openapi_mcp_generator/cli.py	New CLI module
setup.py, pyproject.toml, MANIFEST.in	Packaging updates for proper package installation
README.md, MODULAR_REFACTORING.md	Documentation updated to explain modular design
tests/test_generated_server.py	New tests for validating generated server output

Comments suppressed due to low confidence (5)

setup.py:13

Ensure setup.py's install_requires matches pyproject.toml dependencies—add mcp[cli]>=0.1.0 to avoid missing runtime requirements.

"install_requires=[

.github/workflows/generate-and-test.yml:25

CI references a non-existent requirements.txt; switch to installing via pip install . or using pyproject.toml.

pip install -r requirements.txt

openapi_mcp_generator/generator.py:118

Don’t hardcode auth_type in the template context—use the passed-in auth_type parameter to support all authentication modes.

"auth_type": "bearer",  # Always use bearer auth

tests/test_generated_server.py:1

[nitpick] Consider adding tests for the new CLI entry point and for error paths in parse_openapi_spec to improve coverage of the modular code.

import importlib.util

openapi_mcp_generator/generators.py:59

The Context type is not imported; add from mcp import Context or fully qualify the type to prevent NameError at runtime.

parameters_definitions.append("ctx: Context")

Copilot · 2025-05-23T19:37:20Z

openapi_mcp_generator/cli.py

+        project_dir = generate_mcp_server(
+            args.openapi_file,
+            args.output_dir,
+            args.api_url,
+            args.auth_type,
+            args.api_token,
+            args.api_username,
+            args.api_password
+        )
+
+        print(f"MCP server generated successfully in: {project_dir}")
+        print(f"To build and run the Docker container:")
+        print(f"  cd {project_dir}")
+        print(f"  ./docker.sh build")
+        print(f"  ./docker.sh start --transport=sse")
+        return 0


There’s unreachable duplicate code in the except block after the return; remove the redundant lines to simplify the control flow.

Suggested change

project_dir = generate_mcp_server(

args.openapi_file,

args.output_dir,

args.api_url,

args.auth_type,

args.api_token,

args.api_username,

args.api_password

)

print(f"MCP server generated successfully in: {project_dir}")

print(f"To build and run the Docker container:")

print(f" cd {project_dir}")

print(f" ./docker.sh build")

print(f" ./docker.sh start --transport=sse")

return 0

Copilot · 2025-05-23T19:37:21Z

examples/compatibility_example.py

+from pathlib import Path
+


The Path import is unused—remove it to clean up imports.

Suggested change

from pathlib import Path

Copilot · 2025-05-23T19:37:21Z

README.md

+```python
+from openapi_mcp_generator import generator
+
+generator.generate('samples/TriliumNext/etapi.openapi.yaml')


Update the example to call generate_mcp_server (not generate), matching the actual API function name.

Suggested change

generator.generate('samples/TriliumNext/etapi.openapi.yaml')

generator.generate_mcp_server('samples/TriliumNext/etapi.openapi.yaml')

Copilot · 2025-05-23T19:37:22Z

MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+include requirements.txt


Remove or update the reference to requirements.txt—that file doesn’t exist at the project root.

Suggested change

include requirements.txt

Copilot · 2025-05-23T19:37:22Z

openapi_mcp_generator/parser.py

+        SystemExit: If the file cannot be read or parsed
+    """
+    if not os.path.exists(filepath):
+        print(f"Error: OpenAPI specification file not found: {filepath}")


Error messages should go to stderr (e.g., print(..., file=sys.stderr)) instead of stdout to separate error logging from normal output.

Suggested change

print(f"Error: OpenAPI specification file not found: {filepath}")

print(f"Error: OpenAPI specification file not found: {filepath}", file=sys.stderr)

…sistency

…-mcp-generator into modular-refactor

Copilot AI review requested due to automatic review settings May 23, 2025 19:05

Copilot AI reviewed May 23, 2025

View reviewed changes

openapi_mcp_generator/cli.py Outdated Show resolved Hide resolved

abutbul added 5 commits May 23, 2025 22:10

CI will now verify both generation and correctness of the output.

404c8ed

add pytest installation step in CI workflow for testing generated ser…

8188230

…ver output

mcp should be here

b279f91

Update Python version requirements to 3.10 in workflow and project co…

cb587ee

…nfiguration

Fix formatting of Python version in CI workflow

626c659

abutbul requested a review from Copilot May 23, 2025 19:34

Update openapi_mcp_generator/cli.py

3f016e2

great suggestion. missed out on that Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI reviewed May 23, 2025

View reviewed changes

abutbul added 2 commits May 23, 2025 22:55

Refactor reference resolution in generator and parser modules for con…

e63819a

…sistency

Merge branch 'modular-refactor' of https://github.com/abutbul/openapi…

d6e492b

…-mcp-generator into modular-refactor

abutbul changed the title ~~Refactor codebase into a modular structure with backward compatibility~~ closes #4 Refactor codebase into a modular structure with backward compatibility May 23, 2025

abutbul merged commit 76637aa into main May 23, 2025
1 check passed

abutbul deleted the modular-refactor branch May 23, 2025 20:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

closes #4 Refactor codebase into a modular structure with backward compatibility#8

closes #4 Refactor codebase into a modular structure with backward compatibility#8
abutbul merged 9 commits intomainfrom
modular-refactor

abutbul commented May 23, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 23, 2025

Uh oh!

Copilot AI May 23, 2025

Uh oh!

Copilot AI May 23, 2025

Uh oh!

Copilot AI May 23, 2025

Uh oh!

Copilot AI May 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	generator.generate('samples/TriliumNext/etapi.openapi.yaml')
	generator.generate_mcp_server('samples/TriliumNext/etapi.openapi.yaml')

	print(f"Error: OpenAPI specification file not found: {filepath}")
	print(f"Error: OpenAPI specification file not found: {filepath}", file=sys.stderr)

Conversation

abutbul commented May 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants