README
¶
MCPSmithy
Drop a
.mcpsmithy.yamlin any repo. Run the binary. Every MCP-compatible AI assistant gets project-aware tools; no custom code required. Build MCP tools on the fly for any data source, docs, or codebase.
MCPSmithy is a single Go binary that reads a declarative YAML config file and serves a fully functional MCP tool server. It works for any software project; no language or framework assumptions baked in.
Quick Start
# Build
docker build -t mcpsmithy:latest .
# Or from source (Go 1.26+)
go build -o bin/mcpsmithy ./cmd/mcpsmithy
See the Install guide for editor integration and detailed setup.
Documentation
For Users
| Docs site | Documentation overview |
For Contributors
| .mcpsmithy.yaml | Project sources, conventions, tools, and commands for AI assistants |
| Development Guide | Architecture, CLI, config schema, testing, and security |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gen-docs
command
Command gen-docs generates Markdown reference documentation for mcpsmithy; both CLI (from the Kong command tree) and config schema (from Go struct types and comments via go/ast).
|
Command gen-docs generates Markdown reference documentation for mcpsmithy; both CLI (from the Kong command tree) and config schema (from Go struct types and comments via go/ast). |
|
mcpsmithy
command
Command mcpsmithy is a config-driven MCP tool server.
|
Command mcpsmithy is a config-driven MCP tool server. |
|
internal
|
|
|
config
Package config loads and version-routes .mcpsmithy.yaml configs.
|
Package config loads and version-routes .mcpsmithy.yaml configs. |
|
config/schema
Package schema provides tag-driven defaults and validation for config structs.
|
Package schema provides tag-driven defaults and validation for config structs. |
|
config/v1
Package v1 defines the v1 config schema types for .mcpsmithy.yaml.
|
Package v1 defines the v1 config schema types for .mcpsmithy.yaml. |
|
conventions
Package conventions matches file paths to project documentation and provides browsing of convention definitions.
|
Package conventions matches file paths to project documentation and provides browsing of convention definitions. |
|
glob
Package glob provides shared glob-to-regexp compilation used by the sources and conventions packages.
|
Package glob provides shared glob-to-regexp compilation used by the sources and conventions packages. |
|
project
Package project orchestrates content acquisition and search indexing for the mcpsmithy sources system.
|
Package project orchestrates content acquisition and search indexing for the mcpsmithy sources system. |
|
project/sources
Package sources provides content acquisition from local files, git repositories, and web pages.
|
Package sources provides content acquisition from local files, git repositories, and web pages. |
|
search
Package search provides chunk types, file-to-chunk splitting, and in-memory full-text search with BM25 scoring.
|
Package search provides chunk types, file-to-chunk splitting, and in-memory full-text search with BM25 scoring. |
|
server
Package server wires the mcpsmithy tool engine to the MCP SDK.
|
Package server wires the mcpsmithy tool engine to the MCP SDK. |
|
setup
Package setup implements the config-authoring MCP engine.
|
Package setup implements the config-authoring MCP engine. |
|
tools
Package tools provides the config-driven tool execution engine.
|
Package tools provides the config-driven tool execution engine. |
|
pkg
|
|
|
cmd
Package cmd implements the CLI subcommands.
|
Package cmd implements the CLI subcommands. |
Click to show internal directories.
Click to hide internal directories.