Configuration — MDDB API

Server and MCP configuration

Server configuration #

GET /v1/config

Returns the current server configuration including version, database path, mode, protocol statuses, authentication state, and vector/chunk configuration.

Authorization: BearerAuth or APIKeyAuth or none

Responses #

Status Description Body
200 Server configuration retrieved ConfigResponse (application/json)
401 Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key. ErrorResponse (application/json)
429 The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body. RateLimitError (application/json)

401 example (application/json)

{
  "error": "missing authentication"
}

MCP YAML configuration #

GET /v1/mcp/config

Returns a YAML configuration template for the MCP (Model Context Protocol) server. Includes gRPC and REST connection settings and example custom tool configurations.

Authorization: BearerAuth or APIKeyAuth or none

Responses #

Status Description Body
200 MCP configuration in YAML format string (text/yaml)
401 Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key. ErrorResponse (application/json)
429 The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body. RateLimitError (application/json)

401 example (application/json)

{
  "error": "missing authentication"
}