Home Manager Module
homeManagerModules.syndb installs one SynDB CLI profile and publishes the MCP
servers that profile can serve. It writes no harness configuration: a harness
module reads programs.syndb.mcp.servers.
Options
| Option | Type | Default | Effect |
|---|---|---|---|
programs.syndb.enable | bool | false | Installs programs.syndb.package |
programs.syndb.profile | consumer, provider, developer | "consumer" | Selects the default package and MCP servers |
programs.syndb.package | package | the profile package in packages.x86_64-linux | Overridable, for example with syndb-tools to add the Python export provider. Other systems must set it to a native build |
programs.syndb.serverUrl | null or str | null | Sets SYNDB_SERVER_URL in home.sessionVariables and in each MCP server’s env |
programs.syndb.flightUrl | null or str | null | Sets SYNDB_FLIGHT_URL in the same places; a non-production serverUrl needs it |
programs.syndb.mcp.reviewServerUrl | null or str | null | Sets SYNDB_REVIEW_SERVER_URL on the syndb-review server only |
programs.syndb.mcp.servers | read-only attrs of {command, args, env} | by profile | MCP server data for a harness module |
The module contains no origin. Every endpoint is a caller value: read the
defaults from endpoints.nix in this repository and pass them in. A null
URL leaves the CLI default in place.
Profiles
| Profile | Package | Commands | MCP servers |
|---|---|---|---|
consumer | syndb-cli-consumer | auth, api, query, data download, mcp api, completions | syndb-api |
provider | syndb-cli-provider | consumer commands plus the producer data subcommands, review and mcp review | syndb-api, syndb-review |
developer | syndb-cli-tools | every command, including operator, ETL and manuscript commands and all five MCP modes | syndb-api, syndb-figures, syndb-check, syndb-ops, syndb-review |
Each server is {command = lib.getExe' package "syndb"; args = ["mcp" "<mode>"]; env = {...};},
so the installed binary serves every entry and no separate MCP shim is needed.
Usage
Consumer:
{
imports = [inputs.syndb.homeManagerModules.syndb];
programs.syndb = {enable = true; profile = "consumer";};
}
Provider:
{
imports = [inputs.syndb.homeManagerModules.syndb];
programs.syndb = {enable = true; profile = "provider";};
}
Developer, with the assessor review server:
{
imports = [inputs.syndb.homeManagerModules.syndb];
programs.syndb = {enable = true; profile = "developer"; mcp.reviewServerUrl = (import "${inputs.syndb}/endpoints.nix").api;};
}
A harness module picks the servers it registers by name. Registration is
independent of installation: mcp.servers is data even when enable is false,
so gate it on enable yourself. Start from syndb-api; syndb-figures and
syndb-check act on a SynDB checkout in the harness’s working directory, so
register them only for harnesses that run there. For example, with canix’s
fleetix.mcp.servers:
fleetix.mcp.servers = lib.mkIf config.programs.syndb.enable
(lib.getAttrs ["syndb-api"] config.programs.syndb.mcp.servers);
syndb-review never inherits serverUrl, and review has no default server.
With mcp.reviewServerUrl null the entry sets no review URL: the server starts,
and its tools answer server_not_selected, unless the harness’s own
environment already exports SYNDB_REVIEW_SERVER_URL, which the server then
uses.