Smithy for VS Code

April 22, 2026 ยท View on GitHub

Provides support for the Smithy interface definition language.

Open VSX

Features

  • Syntax highlighting of .smithy files
  • Snippets
  • Completions, jump to definition, and more, powered by smithy-language-server

Configuration

You can configure the extension using VSCode's settings. The following settings are supported:

SettingDescription
smithy.maxNumberOfProblemsControls the maximum number of problems produced by the server.
Default: 100
smithy.trace.serverTraces the communication between VS Code and smithy-language-server.
Options: "off", "messages", "verbose"
Default: "verbose"
smithy.server.executableExecutable to run smithy-language-server, instead of the one managed by the extension. Can be the executable name if it is on your PATH, or an absolute path to the executable. If null, the extension will download it.
Default: null
smithy.server.versionVersion of smithy-language-server to use. Ignored if smithy.server.executable is provided.
smithy.server.diagnostics.minimumSeverityMinimum severity of Smithy validation events to display in the editor.
Options: "NOTE", "WARNING", "DANGER", "ERROR"
Default: "WARNING"

Installation

You can install the extension from the VS Code Extension Marketplace, or from source.

Build from source

To install from source, first clone the repo:

git clone https://github.com/smithy-lang/smithy-vscode.git
cd smithy-vscode

Install the extension's dependencies:

npm install

Install the extension:

npm run install-plugin

This will overwrite any existing installation of the extension with the locally built one.

License

This project is licensed under the Apache-2.0 License.