sn_mcp_register_external_server
Registers an external MCP server with ServiceNow's MCP client so AI agents can use its tools, creating the connection alias, HTTP connection, optional API key credential, and server record.
Instructions
Register an external MCP server (for example the NowAIKit hosted gateway, https://mcp.nowaikit.com/mcp) on the instance's MCP client so ServiceNow AI agents can use its tools. Creates a connection alias, an HTTP connection with the URL, an optional API key credential, and the sn_mcp_server record. Pass connection_alias to reuse an alias you already set up (for OAuth). Adding the server's tools to an agent is then done in AI Agent Studio. REQUIRES WRITE_ENABLED=true and admin.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>"
},
"name": "sn_mcp_register_external_server"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Streamable HTTP MCP endpoint (https), e.g. https://mcp.nowaikit.com/mcp | |
| name | Yes | Server name shown in AI Agent Studio, e.g. "NowAIKit" | |
| api_key | No | Optional API key, stored encrypted in an API Key credential | |
| api_key_header | No | Header that carries the key (default x-nowaikit-key; use Authorization with api_key_prefix "Bearer" for bearer tokens) | |
| api_key_prefix | No | Optional prefix before the key, e.g. Bearer | |
| connection_alias | No | Existing connection alias (sys_alias) sys_id or name to reuse instead of creating one |