Deployment: Dockerfile and Smithery config #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

calclavia wants to merge 3 commits into ssut:main from smithery-ai:smithery/config-j71i

Dockerfile

-Original file line number
+Diff line change
@@ -0,0 +1,21 @@
+    # Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
+    # Use the official lightweight Node.js image
+    FROM node:20-alpine
+    # Set the working directory
+    WORKDIR /app
+    # Copy package.json and tsconfig.json
+    COPY examples/simple-server/package.json examples/simple-server/tsconfig.json ./
+    # Install the dependencies
+    RUN npm install
+    # Copy the application code
+    COPY examples/simple-server .
+    # Expose the application port
+    EXPOSE 9512
+    # Command to run the application
+    CMD ["npm", "run", "start"]

README.md

-Original file line number
+Diff line change
@@ -1,5 +1,7 @@
     # Remote-MCP: Remote Model Context Protocol
+    [![smithery badge](https://smithery.ai/badge/@remote-mcp/client)](https://smithery.ai/server/@remote-mcp/client)
     A **type-safe, bidirectional and simple** solution for **remote MCP communication**, allowing remote access and centralized management of model contexts.
     ![preview](https://github.com/user-attachments/assets/a16804b9-8378-493c-8ca8-f61839458cde)
@@ Expand Down Expand Up @@
     ## References
     *   [Model Context Protocol](https://modelcontextprotocol.org/)

smithery.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    # Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
+    build:
+      dockerBuildPath: examples/simple-server
+    startCommand:
+      type: stdio
+      configSchema:
+        # JSON Schema defining the configuration options for the MCP.
+        type: object
+        required: []
+        properties:
+          port:
+            type: number
+            default: 9512
+            description: The port number on which the server will run.
+      commandFunction:
+        # A function that produces the CLI command to start the MCP on stdio.
+        |-
+        config => ({ command: 'npm', args: ['run', 'start'], env: { PORT: String(config.port) } })

Provide feedback