Skip to content
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

Deployment: Dockerfile and Smithery config #116

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

calclavia
Copy link

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 and a popularity badge. 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. 🙂

@paulgb paulgb self-requested a review February 20, 2025 01:15
@paulgb
Copy link
Member

paulgb commented Feb 20, 2025

Hi @calclavia! Does smithery.yaml need to live in the root directory to be detected? We are trying to keep clutter out of the root directory since this is a monorepo with other projects besides the MCP server.

@calclavia
Copy link
Author

calclavia commented Feb 20, 2025

Hi @calclavia! Does smithery.yaml need to live in the root directory to be detected? We are trying to keep clutter out of the root directory since this is a monorepo with other projects besides the MCP server.

It has to live in the folder where the MCP is at, so if your MCP is within a subdirectory, you can move it there. You'll simply have to adjust the base path setting in Smithery dashboard for your MCP server.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants