README
¶
apimcp
Convert an OpenAPI document into an MCP server. MCP clients can discover API operations as tools and call the existing HTTP service without a second hand-written MCP implementation.
The current adapter supports OpenAPI 3.0.x and 3.1.x JSON/YAML documents within the documented feature boundary. Swagger 2.0 conversion is not included yet.
v0.14.0 is a pre-1.0 compatibility release. It is suitable for local and
controlled deployments, but a public Streamable HTTP endpoint must be placed
behind an authenticating reverse proxy.
go run ./cmd/apimcp `
--spec examples/jsonplaceholder/openapi.yaml
The command above uses the included JSONPlaceholder specification. See the examples guide for available tools and arguments.
See the full English documentation for supported OpenAPI features, authentication, security controls, result contracts, and library usage.
See CONTRIBUTING.md for the contribution workflow.
Documentation
¶
Index ¶
- func NewHTTPHandler(document *Document, options Options) (http.Handler, error)
- func NewServer(document *Document, options Options) (*mcp.Server, error)
- func RunHTTP(ctx context.Context, document *Document, options Options, addr string) error
- func RunStdio(ctx context.Context, document *Document, options Options) error
- type Document
- type LoadOptions
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHTTPHandler ¶ added in v0.8.0
NewHTTPHandler creates a bounded, origin-protected MCP Streamable HTTP handler for document. Callers that expose it to an untrusted network must wrap the returned handler with authentication.
Types ¶
type Document ¶
func LoadFileWithOptions ¶ added in v0.11.0
func LoadFileWithOptions(path string, options LoadOptions) (*Document, error)
LoadFileWithOptions loads an OpenAPI document with an explicit reference policy.
type LoadOptions ¶ added in v0.11.0
type LoadOptions = openapi.LoadOptions
Source Files
Directories