Header Components — MCP Tools
Reusable header components on org, project and spec level. This page documents the Header Components 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 header-components. Full-access keys, scoped keys and OAuth sessions see every tool they are allowed to call without that step.
delete_header_component
Delete a header component at spec or project level. Spec level also needs versionId. Check get_header_component with includeUsage first — policies referencing it lose the header. Requires project context.
Required scope: specs:delete
| Parameter | Type | Required | Description |
|---|---|---|---|
componentId |
string | Yes | Public ID (GUID) of the header component |
level |
string | Yes | Which level the component lives at: 'spec' or 'project' |
specId |
string | No | Public ID (GUID) of the API specification — required for level 'spec' |
versionId |
string | No | Public ID (GUID) of the spec version — required for level 'spec' |
get_header_component
Get one header component with its schema details and rowVersion. Level 'spec' (needs specId) or 'project'. Set includeUsage to also list what references it — spec level only; do that before deleting one. Use this for spec or project level; for the organization level use get_org_header_component. Requires project context.
Required scope: specs:read
| Parameter | Type | Required | Description |
|---|---|---|---|
componentId |
string | Yes | Public ID (GUID) of the header component |
level |
string | Yes | Which level to read: 'spec' or 'project' |
specId |
string | No | Public ID (GUID) of the API specification — required for level 'spec' |
includeUsage |
boolean | No (default false) |
Also list what references this component — spec level only (default false) |
versionId |
string | No | Optional version ID (GUID) to narrow includeUsage to one version |
get_org_header_component
Get one organization-wide header component with its schema details and rowVersion. Use this for the organization level; for spec or project level use get_header_component. Requires organization context.
Required scope: org:manage-governance
| Parameter | Type | Required | Description |
|---|---|---|---|
componentId |
string | Yes | Public ID (GUID) of the header component |
list_header_components
List the header components defined at one level: 'spec' (needs specId) or 'project'. Set includeUsageCounts to see how often each is referenced — spec level only. Returns the ids and rowVersions needed to change them or assign them in a header policy. Requires project context. Use this for spec or project level; for the organization level use list_org_header_components.
Required scope: specs:read
| Parameter | Type | Required | Description |
|---|---|---|---|
level |
string | Yes | Which level to read: 'spec' or 'project' |
specId |
string | No | Public ID (GUID) of the API specification — required for level 'spec' |
versionId |
string | No | Optional version ID (GUID) to filter by a specific version — spec level only |
includeUsageCounts |
boolean | No (default false) |
Also return how often each component is referenced — spec level only (default false) |
list_org_header_components
List the organization-wide header components — the ones organization header policies can assign. Use this for the organization level; for spec or project level use list_header_components. Requires organization context.
Required scope: org:manage-governance
No parameters.
manage_header_component
Create or update a header component at spec or project level. 'create' needs name and schemaType; 'update' needs componentId and rowVersion and REPLACES the component — omitted fields are carried over from the current state, so you can change one alone. Spec level additionally needs versionId. Deleting is delete_header_component. Requires project context.
Required scope: specs:write
| Parameter | Type | Required | Description |
|---|---|---|---|
level |
string | Yes | Which level to write: 'spec' or 'project' |
action |
string | Yes | What to do: 'create' or 'update' |
specId |
string | No | Public ID (GUID) of the API specification — required for level 'spec' |
versionId |
string | No | Public ID (GUID) of the spec version — required for level 'spec' |
componentId |
string | No | Public ID (GUID) of the header component — required for 'update' |
rowVersion |
string | No | Base64-encoded row version from list_header_components — required for 'update' |
name |
string | No | Header name as it appears on the wire (e.g. 'X-Request-Id') — required for 'create' |
schemaType |
string | No | Schema type: 'string', 'integer', 'number', 'boolean', 'array' or 'object' — required for 'create' |
required |
boolean | No (default false) |
Whether the header is required (default false) |
description |
string | No | Optional description |
schemaFormat |
string | No | Optional schema format (e.g. 'uuid', 'date-time') |
schemaId |
string | No | Optional ID (GUID) of a spec schema to link instead of an inline type — spec level only |
example |
string | No | Optional example value |
defaultValue |
string | No | Optional default value |
isDeprecated |
boolean | No (default false) |
Mark the header as deprecated (default false) |
serializedExample |
string | No | 3.2 only: example in wire form (serializedValue) |
manage_org_header_component
Create, update or delete an organization-wide header component. 'create' needs name and schemaType; 'update' needs componentId and rowVersion and REPLACES the component, omitted fields are carried over; 'delete' needs componentId. Use this for the organization level; for spec or project level use manage_header_component. Requires organization context.
Required scope: org:manage-governance
| Parameter | Type | Required | Description |
|---|---|---|---|
action |
string | Yes | What to do: 'create', 'update' or 'delete' |
componentId |
string | No | Public ID (GUID) of the header component — required for 'update' and 'delete' |
rowVersion |
string | No | Base64-encoded row version from list_org_header_components — required for 'update' |
name |
string | No | Header name as it appears on the wire — required for 'create' |
schemaType |
string | No | Schema type: 'string', 'integer', 'number', 'boolean', 'array' or 'object' — required for 'create' |
required |
boolean | No (default false) |
Whether the header is required (default false) |
description |
string | No | Optional description |
schemaFormat |
string | No | Optional schema format (e.g. 'uuid', 'date-time') |
example |
string | No | Optional example value |
defaultValue |
string | No | Optional default value |
isDeprecated |
boolean | No (default false) |
Mark the header as deprecated (default false) |