Blog
smithery.yaml in mcp-mermaid codebase.

smithery.yaml in mcp-mermaid codebase.

In this article, we review smithery.yaml in mcp-mermaid codebase. We will look at:

  1. What is Smithery.ai?

  2. smithery.yaml in mcp-mermaid.

What is Smithery.ai?

Smithery is the largest open marketplace of Model Context Protocol (MCP) servers. Discover and deploy MCP servers that enable LLMs to search the web, access databases, and more.

What can I do with Smithery?

You can use Smithery to build, find, and use MCP servers. We host popular MCP servers like:

  • Exa — Search the live web, access LinkedIn profiles, do deep research, and more

  • Context7 — Reference the latest docs for most major SDKs and frameworks directly in Cursor or Claude Code

  • Browserbase — Control a remote web browser using Stagehand

Quick start

Check out this quick start guide — https://smithery.ai/docs/getting_started/quickstart_build_typescript

Learn more about Smithery.ai.

smithery.yaml in mcp-mermaid

The smithery.yaml file provides configuration for your Model Context Protocol (MCP) server on Smithery. This file must be placed in your repository root.

Below is an example of complex smithery.yaml picked from Smithery docs:

startCommand:
  type: "http"
  configSchema:
    type: "object"
    required: ["apiKey"]
    properties:
      apiKey:
        type: "string"
        title: "API Key"
        description: "Your API key"
      temperature:
        type: "number"
        default: 0.7
        minimum: 0
        maximum: 1
      database:
        type: "object"
        properties:
          host:
            type: "string"
            default: "localhost"
          port:
            type: "integer"
            default: 5432
  exampleConfig:
    apiKey: "sk-example123"
    temperature: 0.8
    database:
      host: "localhost"
      port: 5432

Read more about smithery.yaml configuration options.

Below is the smithery.yaml picked from mcp-mermaid codebase.


# Smithery.ai configuration
startCommand:
  type: stdio
  configSchema:
    # JSON Schema defining the configuration options for the MCP.
    type: object
    properties: {}
  commandFunction:
    # A function that produces the CLI command to start the MCP on stdio.
    |-
    (config) => ({ command: 'node', args: ['./build/index.js'] })
  exampleConfig: {}

About me:

Hey, my name is Ramu Narasinga. I study codebase architecture in large open-source projects.

Email: ramu.narasinga@gmail.com

Want to learn from open-source? Solve challenges inspired by open-source projects.

References:

  1. https://github.com/hustcc/mcp-mermaid/blob/main/smithery.yaml

  2. https://smithery.ai/

  3. https://smithery.ai/docs/build/project-config/smithery-yaml#configuration-options