Deployment: Dockerfile and Smithery config

[calclavia]

This pull request introduces the following updates:

• Dockerfile: Introduces a Dockerfile to package the MCP for deployment across various environments.
• Smithery Configuration: Adds a Smithery YAML file, which specifies how to start the MCP and the configuration options it supports. It allows you to deploy your MCP to Smithery, serving it over WebSockets so end-users do not need to install additional dependencies. To deploy, merge this PR, then visit your server page and click "Deploy" under the deployments page.
• README: Updates the README to include installation instructions via Smithery. Note that the installation only works after the server is deployed on Smithery.

Please review these updates to verify their accuracy for your server and feel free to customize it to your needs. Let me know if you have any questions. 🙂

Summary by CodeRabbit

• New Features

  • Optimized the container deployment process for leaner, more efficient production images.
  • Introduced new configuration options that allow specifying the API specification path during server startup.

• Documentation

  • Expanded the installation guide with instructions for a streamlined setup using the Smithery CLI.

[snaggle-ai]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

Walkthrough

This pull request refactors the build and deployment process for a Node.js application. The Dockerfile now employs a multi-stage build approach with a dedicated builder stage and a slim runtime stage. The README has been updated with a new "Installing via Smithery" section that explains how to install the OpenAPI MCP Server via CLI. Additionally, a new configuration structure is introduced in the smithery.yaml file, which defines a standard IO command and enforces a JSON schema that mandates an openApiJsonPath for starting the server.

Changes

File	Change Summary
Dockerfile	Introduces a multi-stage build: the builder stage (Node.js 23) installs dependencies and builds the project, then copies artifacts to the runtime stage (Node.js 23-slim) which installs production dependencies and sets the entrypoint (npx openapi-mcp-server).
README.md	Adds a new "Installing via Smithery" section with instructions and a command snippet for installing the OpenAPI MCP Server using the Smithery CLI.
smithery.yaml	Introduces a new configuration structure for Smithery, including startCommand (type stdio), a JSON Schema requiring openApiJsonPath, and a commandFunction that generates the start command for the MCP server.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Builder as Build Stage (Node.js 23)
    participant Runtime as Runtime Stage (Node.js 23-slim)
    participant Server as Application Server

    Dev->>Builder: Initiate Docker build
    Builder->>Builder: Copy package.json, pnpm-lock.yaml & install dependencies
    Builder->>Builder: Copy remaining files and build project
    Builder->>Runtime: Transfer build artifacts & dependencies
    Runtime->>Runtime: Install production dependencies
    Runtime->>Server: Set ENTRYPOINT to run npx openapi-mcp-server
    Server-->>Runtime: Server ready

Loading

sequenceDiagram
    participant U as User
    participant CLI as Smithery CLI
    participant Config as smithery.yaml
    participant App as Application Server

    U->>CLI: Run Smithery installation/start command
    CLI->>Config: Read configuration (openApiJsonPath, startCommand)
    Config-->>CLI: Provide command configuration via commandFunction
    CLI->>App: Execute command: npx openapi-mcp-server <openApiJsonPath>
    App-->>CLI: Server initiated

Loading

Poem

I'm a boppy rabbit with a happy little beat,
Hopping through Docker stages with nimble, nimble feet.
Smithery now guides the command with a joyful flair,
Documented in the README with instructions to share.
Code leaps like carrots from the fertile tech-ground,
Celebrating new changes — a hop, a skip, and a bound!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 565a162 and 72f918a.

📒 Files selected for processing (3)

• Dockerfile (1 hunks)
• README.md (1 hunks)
• smithery.yaml (1 hunks)

🔇 Additional comments (9)

smithery.yaml (3)

1-2: Informative Header Comment
The header comment provides a useful reference URL to the Smithery configuration documentation, which can help users understand the context of this file.

---

3-13: Well-Structured Configuration Schema
The YAML block defines the startCommand with a clear configuration schema. The required property openApiJsonPath is properly marked as a string with an accurate description. This description matches the previously suggested text (as noted in past review comments).

---

14-17: Clear Inline Command Function Definition
The commandFunction block uses a block scalar (|-) to succinctly define an inline function that constructs the CLI command. The logic—invoking npx openapi-mcp-server with the provided openApiJsonPath—is clear and aligns with the overall deployment strategy.

Dockerfile (5)

1-3: Solid Build Stage Initialization
The header and the builder stage declaration using node:23 are well chosen. The comments make the purpose of each step clear.

---

5-9: Build Stage Setup and Source Copying
The WORKDIR is appropriately set to /app, and the critical files (pnpm-lock.yaml and package.json) are copied correctly to leverage build caching. This enhances build efficiency.

---

11-19: Efficient Dependency Installation and Build Process
The dependencies are installed using pnpm after globally installing it via npm. The project build is executed as expected. Everything here adheres to best practices for multi-stage Docker builds.

---

20-28: Streamlined Runtime Stage Preparation
Switching to a smaller Node.js image (node:23-slim) for the runtime stage reduces the image size, and copying the built artifacts from the builder stage ensures consistency.

---

29-36: Clear Production Setup and Entrypoint Configuration
The production dependency installation (pnpm install --prod) is correctly done and the ENTRYPOINT setting using npx openapi-mcp-server directly reflects the new server startup logic. The accompanying comment also guides the user regarding the need to supply the OpenAPI JSON file path.

README.md (1)

170-177: Addition of "Installing via Smithery" Section
The new section titled "Installing via Smithery" is clear and concise, providing precise instructions along with a command snippet for using the Smithery CLI. This update harmonizes well with the configurations in smithery.yaml and the Dockerfile's ENTRYPOINT directive.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.