published on Thursday, Aug 20, 2026 by Pulumi
published on Thursday, Aug 20, 2026 by Pulumi
Create AiGatewayMcpService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AiGatewayMcpService(name: string, args: AiGatewayMcpServiceArgs, opts?: CustomResourceOptions);@overload
def AiGatewayMcpService(resource_name: str,
args: AiGatewayMcpServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AiGatewayMcpService(resource_name: str,
opts: Optional[ResourceOptions] = None,
mcp_service_id: Optional[str] = None,
parent: Optional[str] = None,
comment: Optional[str] = None,
config: Optional[AiGatewayMcpServiceConfigArgs] = None,
owner: Optional[str] = None,
provider_config: Optional[AiGatewayMcpServiceProviderConfigArgs] = None)func NewAiGatewayMcpService(ctx *Context, name string, args AiGatewayMcpServiceArgs, opts ...ResourceOption) (*AiGatewayMcpService, error)public AiGatewayMcpService(string name, AiGatewayMcpServiceArgs args, CustomResourceOptions? opts = null)
public AiGatewayMcpService(String name, AiGatewayMcpServiceArgs args)
public AiGatewayMcpService(String name, AiGatewayMcpServiceArgs args, CustomResourceOptions options)
type: databricks:AiGatewayMcpService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "databricks_ai_gateway_mcp_service" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AiGatewayMcpServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AiGatewayMcpServiceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AiGatewayMcpServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AiGatewayMcpServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AiGatewayMcpServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var aiGatewayMcpServiceResource = new Databricks.AiGatewayMcpService("aiGatewayMcpServiceResource", new()
{
McpServiceId = "string",
Parent = "string",
Comment = "string",
Config = new Databricks.Inputs.AiGatewayMcpServiceConfigArgs
{
IncludeToolSelectors = new[]
{
"string",
},
RateLimits = new[]
{
new Databricks.Inputs.AiGatewayMcpServiceConfigRateLimitArgs
{
Key = "string",
RenewalPeriod = "string",
Principal = "string",
RequestTagKey = "string",
RequestTagValue = "string",
Requests = 0,
Tokens = 0,
},
},
SourceConnection = new Databricks.Inputs.AiGatewayMcpServiceConfigSourceConnectionArgs
{
Name = "string",
IsDeleted = false,
},
},
Owner = "string",
ProviderConfig = new Databricks.Inputs.AiGatewayMcpServiceProviderConfigArgs
{
WorkspaceId = "string",
},
});
example, err := databricks.NewAiGatewayMcpService(ctx, "aiGatewayMcpServiceResource", &databricks.AiGatewayMcpServiceArgs{
McpServiceId: pulumi.String("string"),
Parent: pulumi.String("string"),
Comment: pulumi.String("string"),
Config: &databricks.AiGatewayMcpServiceConfigArgs{
IncludeToolSelectors: pulumi.StringArray{
pulumi.String("string"),
},
RateLimits: databricks.AiGatewayMcpServiceConfigRateLimitArray{
&databricks.AiGatewayMcpServiceConfigRateLimitArgs{
Key: pulumi.String("string"),
RenewalPeriod: pulumi.String("string"),
Principal: pulumi.String("string"),
RequestTagKey: pulumi.String("string"),
RequestTagValue: pulumi.String("string"),
Requests: pulumi.Int(0),
Tokens: pulumi.Int(0),
},
},
SourceConnection: &databricks.AiGatewayMcpServiceConfigSourceConnectionArgs{
Name: pulumi.String("string"),
IsDeleted: pulumi.Bool(false),
},
},
Owner: pulumi.String("string"),
ProviderConfig: &databricks.AiGatewayMcpServiceProviderConfigArgs{
WorkspaceId: pulumi.String("string"),
},
})
resource "databricks_ai_gateway_mcp_service" "aiGatewayMcpServiceResource" {
lifecycle {
create_before_destroy = true
}
mcp_service_id = "string"
parent = "string"
comment = "string"
config = {
include_tool_selectors = ["string"]
rate_limits = [{
key = "string"
renewal_period = "string"
principal = "string"
request_tag_key = "string"
request_tag_value = "string"
requests = 0
tokens = 0
}]
source_connection = {
name = "string"
is_deleted = false
}
}
owner = "string"
provider_config = {
workspace_id = "string"
}
}
var aiGatewayMcpServiceResource = new AiGatewayMcpService("aiGatewayMcpServiceResource", AiGatewayMcpServiceArgs.builder()
.mcpServiceId("string")
.parent("string")
.comment("string")
.config(AiGatewayMcpServiceConfigArgs.builder()
.includeToolSelectors("string")
.rateLimits(AiGatewayMcpServiceConfigRateLimitArgs.builder()
.key("string")
.renewalPeriod("string")
.principal("string")
.requestTagKey("string")
.requestTagValue("string")
.requests(0)
.tokens(0)
.build())
.sourceConnection(AiGatewayMcpServiceConfigSourceConnectionArgs.builder()
.name("string")
.isDeleted(false)
.build())
.build())
.owner("string")
.providerConfig(AiGatewayMcpServiceProviderConfigArgs.builder()
.workspaceId("string")
.build())
.build());
ai_gateway_mcp_service_resource = databricks.AiGatewayMcpService("aiGatewayMcpServiceResource",
mcp_service_id="string",
parent="string",
comment="string",
config={
"include_tool_selectors": ["string"],
"rate_limits": [{
"key": "string",
"renewal_period": "string",
"principal": "string",
"request_tag_key": "string",
"request_tag_value": "string",
"requests": 0,
"tokens": 0,
}],
"source_connection": {
"name": "string",
"is_deleted": False,
},
},
owner="string",
provider_config={
"workspace_id": "string",
})
const aiGatewayMcpServiceResource = new databricks.AiGatewayMcpService("aiGatewayMcpServiceResource", {
mcpServiceId: "string",
parent: "string",
comment: "string",
config: {
includeToolSelectors: ["string"],
rateLimits: [{
key: "string",
renewalPeriod: "string",
principal: "string",
requestTagKey: "string",
requestTagValue: "string",
requests: 0,
tokens: 0,
}],
sourceConnection: {
name: "string",
isDeleted: false,
},
},
owner: "string",
providerConfig: {
workspaceId: "string",
},
});
type: databricks:AiGatewayMcpService
properties:
comment: string
config:
includeToolSelectors:
- string
rateLimits:
- key: string
principal: string
renewalPeriod: string
requestTagKey: string
requestTagValue: string
requests: 0
tokens: 0
sourceConnection:
isDeleted: false
name: string
mcpServiceId: string
owner: string
parent: string
providerConfig:
workspaceId: string
AiGatewayMcpService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AiGatewayMcpService resource accepts the following input properties:
- Mcp
Service stringId - Name for the MCP service, e.g. "myMcpService"
- Parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - Comment string
- User-provided description
- Config
Ai
Gateway Mcp Service Config - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - Owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- Provider
Config AiGateway Mcp Service Provider Config - Configure the provider for management through account provider.
- Mcp
Service stringId - Name for the MCP service, e.g. "myMcpService"
- Parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - Comment string
- User-provided description
- Config
Ai
Gateway Mcp Service Config Args - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - Owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- Provider
Config AiGateway Mcp Service Provider Config Args - Configure the provider for management through account provider.
- mcp_
service_ stringid - Name for the MCP service, e.g. "myMcpService"
- parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - comment string
- User-provided description
- config object
- Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- provider_
config object - Configure the provider for management through account provider.
- mcp
Service StringId - Name for the MCP service, e.g. "myMcpService"
- parent String
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - comment String
- User-provided description
- config
Ai
Gateway Mcp Service Config - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - owner String
- The owner of the MCP service. Write-only; read owner via effective_owner
- provider
Config AiGateway Mcp Service Provider Config - Configure the provider for management through account provider.
- mcp
Service stringId - Name for the MCP service, e.g. "myMcpService"
- parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - comment string
- User-provided description
- config
Ai
Gateway Mcp Service Config - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- provider
Config AiGateway Mcp Service Provider Config - Configure the provider for management through account provider.
- mcp_
service_ strid - Name for the MCP service, e.g. "myMcpService"
- parent str
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - comment str
- User-provided description
- config
Ai
Gateway Mcp Service Config Args - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - owner str
- The owner of the MCP service. Write-only; read owner via effective_owner
- provider_
config AiGateway Mcp Service Provider Config Args - Configure the provider for management through account provider.
- mcp
Service StringId - Name for the MCP service, e.g. "myMcpService"
- parent String
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - comment String
- User-provided description
- config Property Map
- Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - owner String
- The owner of the MCP service. Write-only; read owner via effective_owner
- provider
Config Property Map - Configure the provider for management through account provider.
Outputs
All input properties are implicitly available as output properties. Additionally, the AiGatewayMcpService resource produces the following output properties:
- Create
Time string - (string) - When the MCP service was created
- Created
By string - (string) - Creator identity
- Effective
Owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - Etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - Id string
- The provider-assigned unique ID for this managed resource.
- Metastore
Id string - (string) - Metastore hosting the MCP service
- Name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - Update
Time string - (string) - When the MCP service was last modified
- Updated
By string - (string) - Identity of the last updater
- Create
Time string - (string) - When the MCP service was created
- Created
By string - (string) - Creator identity
- Effective
Owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - Etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - Id string
- The provider-assigned unique ID for this managed resource.
- Metastore
Id string - (string) - Metastore hosting the MCP service
- Name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - Update
Time string - (string) - When the MCP service was last modified
- Updated
By string - (string) - Identity of the last updater
- create_
time string - (string) - When the MCP service was created
- created_
by string - (string) - Creator identity
- effective_
owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - id string
- The provider-assigned unique ID for this managed resource.
- metastore_
id string - (string) - Metastore hosting the MCP service
- name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - update_
time string - (string) - When the MCP service was last modified
- updated_
by string - (string) - Identity of the last updater
- create
Time String - (string) - When the MCP service was created
- created
By String - (string) - Creator identity
- effective
Owner String - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag String
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - id String
- The provider-assigned unique ID for this managed resource.
- metastore
Id String - (string) - Metastore hosting the MCP service
- name String
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - update
Time String - (string) - When the MCP service was last modified
- updated
By String - (string) - Identity of the last updater
- create
Time string - (string) - When the MCP service was created
- created
By string - (string) - Creator identity
- effective
Owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - id string
- The provider-assigned unique ID for this managed resource.
- metastore
Id string - (string) - Metastore hosting the MCP service
- name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - update
Time string - (string) - When the MCP service was last modified
- updated
By string - (string) - Identity of the last updater
- create_
time str - (string) - When the MCP service was created
- created_
by str - (string) - Creator identity
- effective_
owner str - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag str
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - id str
- The provider-assigned unique ID for this managed resource.
- metastore_
id str - (string) - Metastore hosting the MCP service
- name str
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - update_
time str - (string) - When the MCP service was last modified
- updated_
by str - (string) - Identity of the last updater
- create
Time String - (string) - When the MCP service was created
- created
By String - (string) - Creator identity
- effective
Owner String - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag String
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - id String
- The provider-assigned unique ID for this managed resource.
- metastore
Id String - (string) - Metastore hosting the MCP service
- name String
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - update
Time String - (string) - When the MCP service was last modified
- updated
By String - (string) - Identity of the last updater
Look up Existing AiGatewayMcpService Resource
Get an existing AiGatewayMcpService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AiGatewayMcpServiceState, opts?: CustomResourceOptions): AiGatewayMcpService@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
config: Optional[AiGatewayMcpServiceConfigArgs] = None,
create_time: Optional[str] = None,
created_by: Optional[str] = None,
effective_owner: Optional[str] = None,
etag: Optional[str] = None,
mcp_service_id: Optional[str] = None,
metastore_id: Optional[str] = None,
name: Optional[str] = None,
owner: Optional[str] = None,
parent: Optional[str] = None,
provider_config: Optional[AiGatewayMcpServiceProviderConfigArgs] = None,
update_time: Optional[str] = None,
updated_by: Optional[str] = None) -> AiGatewayMcpServicefunc GetAiGatewayMcpService(ctx *Context, name string, id IDInput, state *AiGatewayMcpServiceState, opts ...ResourceOption) (*AiGatewayMcpService, error)public static AiGatewayMcpService Get(string name, Input<string> id, AiGatewayMcpServiceState? state, CustomResourceOptions? opts = null)public static AiGatewayMcpService get(String name, Output<String> id, AiGatewayMcpServiceState state, CustomResourceOptions options)resources: _: type: databricks:AiGatewayMcpService get: id: ${id}import {
to = databricks_ai_gateway_mcp_service.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Comment string
- User-provided description
- Config
Ai
Gateway Mcp Service Config - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - Create
Time string - (string) - When the MCP service was created
- Created
By string - (string) - Creator identity
- Effective
Owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - Etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - Mcp
Service stringId - Name for the MCP service, e.g. "myMcpService"
- Metastore
Id string - (string) - Metastore hosting the MCP service
- Name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - Owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- Parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - Provider
Config AiGateway Mcp Service Provider Config - Configure the provider for management through account provider.
- Update
Time string - (string) - When the MCP service was last modified
- Updated
By string - (string) - Identity of the last updater
- Comment string
- User-provided description
- Config
Ai
Gateway Mcp Service Config Args - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - Create
Time string - (string) - When the MCP service was created
- Created
By string - (string) - Creator identity
- Effective
Owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - Etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - Mcp
Service stringId - Name for the MCP service, e.g. "myMcpService"
- Metastore
Id string - (string) - Metastore hosting the MCP service
- Name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - Owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- Parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - Provider
Config AiGateway Mcp Service Provider Config Args - Configure the provider for management through account provider.
- Update
Time string - (string) - When the MCP service was last modified
- Updated
By string - (string) - Identity of the last updater
- comment string
- User-provided description
- config object
- Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - create_
time string - (string) - When the MCP service was created
- created_
by string - (string) - Creator identity
- effective_
owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - mcp_
service_ stringid - Name for the MCP service, e.g. "myMcpService"
- metastore_
id string - (string) - Metastore hosting the MCP service
- name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - provider_
config object - Configure the provider for management through account provider.
- update_
time string - (string) - When the MCP service was last modified
- updated_
by string - (string) - Identity of the last updater
- comment String
- User-provided description
- config
Ai
Gateway Mcp Service Config - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - create
Time String - (string) - When the MCP service was created
- created
By String - (string) - Creator identity
- effective
Owner String - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag String
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - mcp
Service StringId - Name for the MCP service, e.g. "myMcpService"
- metastore
Id String - (string) - Metastore hosting the MCP service
- name String
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - owner String
- The owner of the MCP service. Write-only; read owner via effective_owner
- parent String
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - provider
Config AiGateway Mcp Service Provider Config - Configure the provider for management through account provider.
- update
Time String - (string) - When the MCP service was last modified
- updated
By String - (string) - Identity of the last updater
- comment string
- User-provided description
- config
Ai
Gateway Mcp Service Config - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - create
Time string - (string) - When the MCP service was created
- created
By string - (string) - Creator identity
- effective
Owner string - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag string
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - mcp
Service stringId - Name for the MCP service, e.g. "myMcpService"
- metastore
Id string - (string) - Metastore hosting the MCP service
- name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - owner string
- The owner of the MCP service. Write-only; read owner via effective_owner
- parent string
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - provider
Config AiGateway Mcp Service Provider Config - Configure the provider for management through account provider.
- update
Time string - (string) - When the MCP service was last modified
- updated
By string - (string) - Identity of the last updater
- comment str
- User-provided description
- config
Ai
Gateway Mcp Service Config Args - Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - create_
time str - (string) - When the MCP service was created
- created_
by str - (string) - Creator identity
- effective_
owner str - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag str
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - mcp_
service_ strid - Name for the MCP service, e.g. "myMcpService"
- metastore_
id str - (string) - Metastore hosting the MCP service
- name str
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - owner str
- The owner of the MCP service. Write-only; read owner via effective_owner
- parent str
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - provider_
config AiGateway Mcp Service Provider Config Args - Configure the provider for management through account provider.
- update_
time str - (string) - When the MCP service was last modified
- updated_
by str - (string) - Identity of the last updater
- comment String
- User-provided description
- config Property Map
- Operational configuration: connection, tool selectors, rate limit.
Required on CreateMcpService; on
UpdateMcpService it is required only when
config(or aconfig.*subpath) appears inupdateMask - create
Time String - (string) - When the MCP service was created
- created
By String - (string) - Creator identity
- effective
Owner String - (string) - The resolved owner of the MCP service. Falls back to the caller's identity
when
owneris not explicitly set on creation - etag String
- (string) - Optimistic concurrency control token. Server-generated from the
entity's state and returned on every read. To use it as an if-match
precondition on a mutation, echo the last-read value back via the dedicated
etagfield on the Update / Delete request; the server rejects the mutation if the stored etag differs - mcp
Service StringId - Name for the MCP service, e.g. "myMcpService"
- metastore
Id String - (string) - Metastore hosting the MCP service
- name String
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - owner String
- The owner of the MCP service. Write-only; read owner via effective_owner
- parent String
- Name of the parent schema.
Format:
schemas/{catalog}.{schema}. Each{...}component is capped at 255 characters individually - provider
Config Property Map - Configure the provider for management through account provider.
- update
Time String - (string) - When the MCP service was last modified
- updated
By String - (string) - Identity of the last updater
Supporting Types
AiGatewayMcpServiceConfig, AiGatewayMcpServiceConfigArgs
- Include
Tool List<string>Selectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - Rate
Limits List<AiGateway Mcp Service Config Rate Limit> - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - Source
Connection AiGateway Mcp Service Config Source Connection - UC Connection referencing the MCP server
- Include
Tool []stringSelectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - Rate
Limits []AiGateway Mcp Service Config Rate Limit - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - Source
Connection AiGateway Mcp Service Config Source Connection - UC Connection referencing the MCP server
- include_
tool_ list(string)selectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - rate_
limits list(object) - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - source_
connection object - UC Connection referencing the MCP server
- include
Tool List<String>Selectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - rate
Limits List<AiGateway Mcp Service Config Rate Limit> - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - source
Connection AiGateway Mcp Service Config Source Connection - UC Connection referencing the MCP server
- include
Tool string[]Selectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - rate
Limits AiGateway Mcp Service Config Rate Limit[] - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - source
Connection AiGateway Mcp Service Config Source Connection - UC Connection referencing the MCP server
- include_
tool_ Sequence[str]selectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - rate_
limits Sequence[AiGateway Mcp Service Config Rate Limit] - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - source_
connection AiGateway Mcp Service Config Source Connection - UC Connection referencing the MCP server
- include
Tool List<String>Selectors - Glob or exact-match patterns selecting which tools from the MCP server
to expose. Prefix match for patterns with
*, exact match otherwise. An empty list means all tools are included. Per-element max 256 chars - rate
Limits List<Property Map> - Per-principal rate limits applied to tool invocations routed through this
MCP service. Repeated to support per-USER / USER_GROUP / SERVICE_PRINCIPAL
/ SERVICE / USER_DEFAULT scopes simultaneously, mirroring the
ModelServiceConfig.rate_limitsshape. Empty when no rate limit is configured - source
Connection Property Map - UC Connection referencing the MCP server
AiGatewayMcpServiceConfigRateLimit, AiGatewayMcpServiceConfigRateLimitArgs
- Key string
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - Renewal
Period string - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - Principal string
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - Request
Tag stringKey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - Request
Tag stringValue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - Requests int
- Max requests allowed within a renewal period. Leave unset for no request limit
- Tokens int
- Max tokens allowed within a renewal period. Leave unset for no token limit
- Key string
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - Renewal
Period string - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - Principal string
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - Request
Tag stringKey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - Request
Tag stringValue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - Requests int
- Max requests allowed within a renewal period. Leave unset for no request limit
- Tokens int
- Max tokens allowed within a renewal period. Leave unset for no token limit
- key string
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - renewal_
period string - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - principal string
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - request_
tag_ stringkey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - request_
tag_ stringvalue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - requests number
- Max requests allowed within a renewal period. Leave unset for no request limit
- tokens number
- Max tokens allowed within a renewal period. Leave unset for no token limit
- key String
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - renewal
Period String - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - principal String
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - request
Tag StringKey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - request
Tag StringValue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - requests Integer
- Max requests allowed within a renewal period. Leave unset for no request limit
- tokens Integer
- Max tokens allowed within a renewal period. Leave unset for no token limit
- key string
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - renewal
Period string - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - principal string
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - request
Tag stringKey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - request
Tag stringValue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - requests number
- Max requests allowed within a renewal period. Leave unset for no request limit
- tokens number
- Max tokens allowed within a renewal period. Leave unset for no token limit
- key str
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - renewal_
period str - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - principal str
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - request_
tag_ strkey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - request_
tag_ strvalue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - requests int
- Max requests allowed within a renewal period. Leave unset for no request limit
- tokens int
- Max tokens allowed within a renewal period. Leave unset for no token limit
- key String
- Scope key. Determines whether
principalis required. Possible values are:RATE_LIMIT_KEY_REQUEST_TAG,RATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_SERVICE_PRINCIPAL,RATE_LIMIT_KEY_USER,RATE_LIMIT_KEY_USER_DEFAULT,RATE_LIMIT_KEY_USER_GROUP - renewal
Period String - Renewal period. Possible values are:
RATE_LIMIT_RENEWAL_PERIOD_HOUR,RATE_LIMIT_RENEWAL_PERIOD_MINUTE - principal String
- Principal this limit applies to: user email, group name, or service
principal application ID. Required unless
keyisRATE_LIMIT_KEY_SERVICE,RATE_LIMIT_KEY_USER_DEFAULT, orRATE_LIMIT_KEY_REQUEST_TAG(which must not set a principal) - request
Tag StringKey - Request tag key this limit applies to. Required when
keyisRATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise - request
Tag StringValue - Request tag value this limit applies to. Only valid when
keyisRATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value ofrequestTagKey(an any-value default); a set value is a specific override for that value - requests Number
- Max requests allowed within a renewal period. Leave unset for no request limit
- tokens Number
- Max tokens allowed within a renewal period. Leave unset for no token limit
AiGatewayMcpServiceConfigSourceConnection, AiGatewayMcpServiceConfigSourceConnectionArgs
- name string
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - is_
deleted bool - (boolean)
- name str
- (string) - Resource name of the MCP service.
Format:
mcp-services/{catalog}.{schema}.{mcp_service}. Each{...}component is capped at 255 characters individually. Server-derived on Create fromparent+mcpServiceId; required and immutable on Update/Get/Delete - is_
deleted bool - (boolean)
AiGatewayMcpServiceProviderConfig, AiGatewayMcpServiceProviderConfigArgs
- Workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- Workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace_
id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace_
id str - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
published on Thursday, Aug 20, 2026 by Pulumi