Skip to content

Deployment: Smithery config #31

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

Merged
merged 5 commits into from
Jun 11, 2025
Merged

Conversation

calclavia
Copy link
Contributor

This PR adds files for deploying your MCP server on Smithery. After deployment, users can use your server over WebSockets (hosted on Smithery) without needing to install any dependencies.

Changes

  • Added Dockerfile to package your server for deployment.
  • Added Smithery Configuration file to specify how to start your server. See documentation.
  • Updated README to include installation command via Smithery and a popularity badge. Note that the command only works after the server is deployed on Smithery.

Server Details

Action Items

  • Build Passing: We verified that the Docker builds and your server starts up using an automated test.
  • Code Review: Please review the changes to ensure the configuration is accurate for your server.
  • Claim Server: Head to your server page to claim your server. This will let you edit your server listing on Smithery and deploy new versions of your server.

@calclavia calclavia requested a review from a team as a code owner April 8, 2025 02:02
Copy link

cla-checker-service bot commented Apr 8, 2025

💚 CLA has been signed

@jedrazb
Copy link
Member

jedrazb commented Apr 8, 2025

Hey @calclavia, thanks for your contribution! In order for us to be able to merge your changes, please sign the contributor agreement.

@jedrazb
Copy link
Member

jedrazb commented Apr 8, 2025

buildkite test this

@calclavia
Copy link
Contributor Author

Hey @calclavia, thanks for your contribution! In order for us to be able to merge your changes, please sign the contributor agreement.

Just signed

@jedrazb
Copy link
Member

jedrazb commented Apr 10, 2025

Thank you, one more thing (as mentioned in #37 (comment)).

We prefer to build the image on top of Chainguard’s hardened Wolfi base image. Switching to the publicly available cgr.dev/chainguard/wolfi-base:latest (example) would reduce our maintenance burden in the long run.

Once we have the repos Dockerfile ready, I will loop back to this PR (I assume dockerfile is required for Smithery, right?)

@calclavia
Copy link
Contributor Author

Thank you, one more thing (as mentioned in #37 (comment)).

We prefer to build the image on top of Chainguard’s hardened Wolfi base image. Switching to the publicly available cgr.dev/chainguard/wolfi-base:latest (example) would reduce our maintenance burden in the long run.

Once we have the repos Dockerfile ready, I will loop back to this PR (I assume dockerfile is required for Smithery, right?)

Yep! Dockerfile is required. Since I'm not familiar with the specific image needs, you can feel free to make this change to the Dockerfile: You should have permission on the branch to make PR. Thanks!

@JoshMock
Copy link
Member

A Dockerfile has been added in #80/#82 that uses a public, Elastic-approved Wolfi image. Feel free to rebase this PR and just add the Smithery config.

@calclavia calclavia requested a review from a team as a code owner June 10, 2025 20:29
@calclavia
Copy link
Contributor Author

A Dockerfile has been added in #80/#82 that uses a public, Elastic-approved Wolfi image. Feel free to rebase this PR and just add the Smithery config.

done!

@JoshMock JoshMock changed the title Deployment: Dockerfile and Smithery config Deployment: Smithery config Jun 11, 2025
Copy link
Member

@JoshMock JoshMock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I've not used Smithery before, but I'll set up an official page for it on their registry after merging.

@JoshMock JoshMock merged commit 8e6fd79 into elastic:main Jun 11, 2025
1 check passed
@JoshMock
Copy link
Member

@JoshMock
Copy link
Member

It looks like that build failed. Dockerfile seems to have failed their tests.

Docs say:

We only support Linux Docker images on major distros (Alpine/Debian-based) and expect sh to run in your container. Other distros are untested and may not deploy.

I may need to add sh to the Dockerfile to ensure Smithery compatibility. Opened #85 to track.

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.

3 participants