Skip to main content
This guide explains how to configure your project for deployment on Smithery. Your project configuration tells us how to deploy your server and should live in the base of your repository. They are not the same as session configurations that clients pass to initialize a new session on your server.

​
Concepts

​
Configuration Files

There is one primary configuration file that tells Smithery how to build and run your server:
  1. smithery.yaml: Specifies the runtime and environment for your server

​
Automatic Setup

Smithery will attempt to automatically generate a pull-request with this file when you trigger a deployment. However, in some cases, the setup can fail and you may need to set this up manually.

​
Required Files

​
smithery.yaml

The smithery.yaml file tells us how to deploy your server. It should be placed in the root of your project or in the subdirectory containing your MCP server. 
runtime: "typescript"

​
Project Structure

​
Subdirectories

If your package is not in the root directory of your repository (in the case of a monorepo), you should place your smithery.yaml in the subdirectory that contains your package. You will need to specify the base directory in your server settings on Smithery. For example, if your MCP server is in the packages/mcp-server directory:
  1. Place your smithery.yaml in the packages/mcp-server directory
  2. Set the base directory to packages/mcp-server in your server settings under Github integration

​
Best Practices

  1. Testing: Test your MCP server locally before deploying using the Smithery CLI (npm run dev).
  2. Configuration: Use the configSchema export in your code to properly define and validate your server’s session configuration options.

​
Next Steps

Once you have configured your project, you can deploy your server.