For AI agents: the complete documentation index is at https://docs.routebase.dev/llms.txt. Every page is also available as Markdown by appending index.md to its URL or by sending Accept: text/markdown.
MCP Reference

Auth Configuration — MCP Tools

Auth configurations for test environments (org defaults and per-environment). This page documents the Auth Configuration group of the Routebase MCP server, with the scope and the parameters of each tool.

A session that stages its tools advertises this group once the agent calls enable_toolset with the slug auth. Full-access keys, scoped keys and OAuth sessions see every tool they are allowed to call without that step.

delete_environment_auth

Remove the environment-level authentication configuration. Use this to clear the environment layer; for one suite or case use set_suite_auth or set_testcase_auth. Requires organization context.

Required scope: tests:write

Parameter Type Required Description
environmentId string Yes Public ID (GUID) of the environment
projectId string No Public ID (GUID) of the project. If omitted, uses the active project context.

get_environment_auth

Get the environment-level authentication configuration for an environment. Secret values are always masked. Returns {configured:false} when no auth is set. Requires organization context (call set_context first).

Required scope: tests:read

Parameter Type Required Description
environmentId string Yes Public ID (GUID) of the environment
projectId string No Public ID (GUID) of the project. If omitted, uses the active project context.

set_environment_auth

Set (upsert) the environment-level authentication configuration. Applies to all test suites/cases running against this environment unless they override it. Common types are configured via simple parameters: 'none' (no auth); 'basic' (username/password); 'bearer' (token); 'apiKey' (keyName/keyValue/in). Any value may contain environment-variable references like '{{apiKey}}' — these are stored verbatim and resolved at run time (not encrypted). Literal secret values are encrypted at rest and masked in responses. Advanced types (oauth2, jwt, awsSigv4, oauth1, digest, hawk, ntlm) are configured by passing the full JSON config as 'advancedConfigJson' (same shape as the REST SetAuthConfigRequest, including its own 'type' field). Use this for the whole environment; for one suite or case use set_suite_auth or set_testcase_auth. Requires organization context.

Required scope: tests:write

Parameter Type Required Description
environmentId string Yes Public ID (GUID) of the environment
type string No Auth type: 'none', 'basic', 'bearer', 'apiKey' (for advanced types use advancedConfigJson)
username string No Basic auth: username (also used for digest/ntlm via advancedConfigJson)
password string No Basic auth: password
token string No Bearer auth: the token value (may be a '{{VAR}}' reference)
keyName string No API key auth: the header/query parameter name (e.g. 'X-API-Key')
keyValue string No API key auth: the key value (may be a '{{VAR}}' reference)
in string No API key auth: where to place the key — 'header' (default) or 'query'
advancedConfigJson string No Full JSON auth config for advanced types (oauth2, jwt, awsSigv4, …); must include its own 'type' field. When provided, the simple parameters are ignored.
projectId string No Public ID (GUID) of the project. If omitted, uses the active project context.

set_suite_auth

Set the authentication override for a test suite. authMode 'inherit' clears the override (the suite inherits the environment/project auth); authMode 'override' sets a suite-specific auth config (provide 'type' plus simple parameters, or 'advancedConfigJson' for advanced types — same shape as set_environment_auth). Returns the resolved auth with its inheritance source. Requires project context.

Required scope: tests:write

Parameter Type Required Description
testSuiteId string Yes Public ID (GUID) of the test suite
authMode string Yes Auth mode: 'inherit' (clear override) or 'override' (set suite-specific auth)
type string No Auth type (required for 'override'): 'none', 'basic', 'bearer', 'apiKey'
username string No Basic auth: username
password string No Basic auth: password
token string No Bearer auth: the token value (may be a '{{VAR}}' reference)
keyName string No API key auth: the header/query parameter name
keyValue string No API key auth: the key value (may be a '{{VAR}}' reference)
in string No API key auth: 'header' (default) or 'query'
advancedConfigJson string No Full JSON auth config for advanced types; must include its own 'type' field.

set_testcase_auth

Set the authentication override for a test case. authMode 'inherit' clears the override (the case inherits the suite/environment auth); authMode 'override' sets a case-specific auth config (provide 'type' plus simple parameters, or 'advancedConfigJson' for advanced types). Returns the resolved auth with its inheritance source. Use this for one case; for every case in the suite use set_suite_auth. Requires project context.

Required scope: tests:write

Parameter Type Required Description
testCaseId string Yes Public ID (GUID) of the test case
authMode string Yes Auth mode: 'inherit' (clear override) or 'override' (set case-specific auth)
type string No Auth type (required for 'override'): 'none', 'basic', 'bearer', 'apiKey'
username string No Basic auth: username
password string No Basic auth: password
token string No Bearer auth: the token value (may be a '{{VAR}}' reference)
keyName string No API key auth: the header/query parameter name
keyValue string No API key auth: the key value (may be a '{{VAR}}' reference)
in string No API key auth: 'header' (default) or 'query'
advancedConfigJson string No Full JSON auth config for advanced types; must include its own 'type' field.