Provides a Open Api Explorer Api Mcp Server resource.
API MCP Server.
For information about Open Api Explorer Api Mcp Server and how to use it, see What is Api Mcp Server.
NOTE: Available since v1.266.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new alicloud.OpenApiExplorerApiMcpServer("default", {
systemTools: ["FetchRamActionDetails"],
description: "Create",
prompts: [
{
description: "Obtain user customization information description",
content: "Prompt body,{{name}}",
arguments: [{
description: "Name information",
required: true,
name: "name",
}],
name: "Obtain user customization information",
},
{
description: "Obtain user customization information description",
content: "Prompt text, {{name }}, {{age }}, {{description}}",
arguments: [
{
description: "Name information",
required: true,
name: "name",
},
{
description: "Age information",
required: true,
name: "age",
},
{
description: "Description Information",
required: true,
name: "description",
},
],
name: "Obtain user customization information 1",
},
],
oauthClientId: "123456",
apis: [
{
apiVersion: "2014-05-26",
product: "Ecs",
selectors: [
"DescribeAvailableResource",
"DescribeRegions",
"DescribeZones",
],
},
{
apiVersion: "2017-03-21",
product: "vod",
selectors: ["CreateUploadVideo"],
},
{
apiVersion: "2014-05-15",
product: "Slb",
selectors: ["DescribeAvailableResource"],
},
],
instructions: "Describes the role of the entire MCP Server",
additionalApiDescriptions: [
{
apiVersion: "2014-05-26",
enableOutputSchema: true,
apiName: "DescribeAvailableResource",
constParameters: [
{
value: "cn-hangzhou",
key: "x_mcp_region_id",
},
{
value: "B1",
key: "a1",
},
{
value: "b2",
key: "a2",
},
],
apiOverrideJson: JSON.stringify({
summary: "This operation supports querying the list of instances based on different request conditions and associating the query instance details. ",
}),
product: "Ecs",
executeCliCommand: false,
},
{
apiVersion: "2014-05-26",
enableOutputSchema: true,
apiName: "DescribeRegions",
product: "Ecs",
executeCliCommand: true,
},
{
apiVersion: "2014-05-26",
enableOutputSchema: true,
apiName: "DescribeZones",
product: "Ecs",
executeCliCommand: true,
},
],
vpcWhitelists: [
"vpc-examplea",
"vpc-exampleb",
"vpc-examplec",
],
name: "my-name",
language: "ZH_CN",
enableAssumeRole: true,
assumeRoleExtraPolicy: JSON.stringify({
Version: "1",
Statement: [{
Effect: "Allow",
Action: [
"ecs:Describe*",
"vpc:Describe*",
"vpc:List*",
],
Resource: "*",
}],
}),
terraformTools: [
{
description: "Terraform as tool example",
async: true,
destroyPolicy: "NEVER",
code: `variable \\"name\\" {
default = \\"terraform-example\\"
}
provider \\"alicloud\\" {
region = \\"cn-beijing\\"
}
resource \\"alicloud_vpc\\" \\"default\\" {
ipv6_isp = \\"BGP\\"
description = \\"example\\"
cidr_block = \\"10.0.0.0/8\\"
vpc_name = var.name
enable_ipv6 = true
}
`,
name: "tfexample",
},
{
description: "Terraform as tool example",
async: true,
destroyPolicy: "NEVER",
code: `variable \\"name\\" {
default = \\"terraform-example\\"
}
provider \\"alicloud\\" {
region = \\"cn-beijing\\"
}
resource \\"alicloud_vpc\\" \\"default\\" {
ipv6_isp = \\"BGP\\"
description = \\"example\\"
cidr_block = \\"10.0.0.0/8\\"
vpc_name = var.name
enable_ipv6 = true
}
`,
name: "tfexample2",
},
{
description: "Terraform as tool example",
async: true,
destroyPolicy: "NEVER",
code: `variable \\"name\\" {
default = \\"terraform-example\\"
}
provider \\"alicloud\\" {
region = \\"cn-beijing\\"
}
resource \\"alicloud_vpc\\" \\"default\\" {
ipv6_isp = \\"BGP\\"
description = \\"example\\"
cidr_block = \\"10.0.0.0/8\\"
vpc_name = var.name
enable_ipv6 = true
}
`,
name: "tfexample3",
},
],
assumeRoleName: "default-role",
publicAccess: "on",
enableCustomVpcWhitelist: true,
});
import pulumi
import json
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
default = alicloud.OpenApiExplorerApiMcpServer("default",
system_tools=["FetchRamActionDetails"],
description="Create",
prompts=[
{
"description": "Obtain user customization information description",
"content": "Prompt body,{{name}}",
"arguments": [{
"description": "Name information",
"required": True,
"name": "name",
}],
"name": "Obtain user customization information",
},
{
"description": "Obtain user customization information description",
"content": "Prompt text, {{name }}, {{age }}, {{description}}",
"arguments": [
{
"description": "Name information",
"required": True,
"name": "name",
},
{
"description": "Age information",
"required": True,
"name": "age",
},
{
"description": "Description Information",
"required": True,
"name": "description",
},
],
"name": "Obtain user customization information 1",
},
],
oauth_client_id="123456",
apis=[
{
"api_version": "2014-05-26",
"product": "Ecs",
"selectors": [
"DescribeAvailableResource",
"DescribeRegions",
"DescribeZones",
],
},
{
"api_version": "2017-03-21",
"product": "vod",
"selectors": ["CreateUploadVideo"],
},
{
"api_version": "2014-05-15",
"product": "Slb",
"selectors": ["DescribeAvailableResource"],
},
],
instructions="Describes the role of the entire MCP Server",
additional_api_descriptions=[
{
"api_version": "2014-05-26",
"enable_output_schema": True,
"api_name": "DescribeAvailableResource",
"const_parameters": [
{
"value": "cn-hangzhou",
"key": "x_mcp_region_id",
},
{
"value": "B1",
"key": "a1",
},
{
"value": "b2",
"key": "a2",
},
],
"api_override_json": json.dumps({
"summary": "This operation supports querying the list of instances based on different request conditions and associating the query instance details. ",
}),
"product": "Ecs",
"execute_cli_command": False,
},
{
"api_version": "2014-05-26",
"enable_output_schema": True,
"api_name": "DescribeRegions",
"product": "Ecs",
"execute_cli_command": True,
},
{
"api_version": "2014-05-26",
"enable_output_schema": True,
"api_name": "DescribeZones",
"product": "Ecs",
"execute_cli_command": True,
},
],
vpc_whitelists=[
"vpc-examplea",
"vpc-exampleb",
"vpc-examplec",
],
name="my-name",
language="ZH_CN",
enable_assume_role=True,
assume_role_extra_policy=json.dumps({
"Version": "1",
"Statement": [{
"Effect": "Allow",
"Action": [
"ecs:Describe*",
"vpc:Describe*",
"vpc:List*",
],
"Resource": "*",
}],
}),
terraform_tools=[
{
"description": "Terraform as tool example",
"async_": True,
"destroy_policy": "NEVER",
"code": """variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
""",
"name": "tfexample",
},
{
"description": "Terraform as tool example",
"async_": True,
"destroy_policy": "NEVER",
"code": """variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
""",
"name": "tfexample2",
},
{
"description": "Terraform as tool example",
"async_": True,
"destroy_policy": "NEVER",
"code": """variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
""",
"name": "tfexample3",
},
],
assume_role_name="default-role",
public_access="on",
enable_custom_vpc_whitelist=True)
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"summary": "This operation supports querying the list of instances based on different request conditions and associating the query instance details. ",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
tmpJSON1, err := json.Marshal(map[string]interface{}{
"Version": "1",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Effect": "Allow",
"Action": []string{
"ecs:Describe*",
"vpc:Describe*",
"vpc:List*",
},
"Resource": "*",
},
},
})
if err != nil {
return err
}
json1 := string(tmpJSON1)
_, err = alicloud.NewOpenApiExplorerApiMcpServer(ctx, "default", &alicloud.OpenApiExplorerApiMcpServerArgs{
SystemTools: pulumi.StringArray{
pulumi.String("FetchRamActionDetails"),
},
Description: pulumi.String("Create"),
Prompts: alicloud.OpenApiExplorerApiMcpServerPromptArray{
&alicloud.OpenApiExplorerApiMcpServerPromptArgs{
Description: pulumi.String("Obtain user customization information description"),
Content: pulumi.String("Prompt body,{{name}}"),
Arguments: alicloud.OpenApiExplorerApiMcpServerPromptArgumentArray{
&alicloud.OpenApiExplorerApiMcpServerPromptArgumentArgs{
Description: pulumi.String("Name information"),
Required: pulumi.Bool(true),
Name: pulumi.String("name"),
},
},
Name: pulumi.String("Obtain user customization information"),
},
&alicloud.OpenApiExplorerApiMcpServerPromptArgs{
Description: pulumi.String("Obtain user customization information description"),
Content: pulumi.String("Prompt text, {{name }}, {{age }}, {{description}}"),
Arguments: alicloud.OpenApiExplorerApiMcpServerPromptArgumentArray{
&alicloud.OpenApiExplorerApiMcpServerPromptArgumentArgs{
Description: pulumi.String("Name information"),
Required: pulumi.Bool(true),
Name: pulumi.String("name"),
},
&alicloud.OpenApiExplorerApiMcpServerPromptArgumentArgs{
Description: pulumi.String("Age information"),
Required: pulumi.Bool(true),
Name: pulumi.String("age"),
},
&alicloud.OpenApiExplorerApiMcpServerPromptArgumentArgs{
Description: pulumi.String("Description Information"),
Required: pulumi.Bool(true),
Name: pulumi.String("description"),
},
},
Name: pulumi.String("Obtain user customization information 1"),
},
},
OauthClientId: pulumi.String("123456"),
Apis: alicloud.OpenApiExplorerApiMcpServerApiArray{
&alicloud.OpenApiExplorerApiMcpServerApiArgs{
ApiVersion: pulumi.String("2014-05-26"),
Product: pulumi.String("Ecs"),
Selectors: pulumi.StringArray{
pulumi.String("DescribeAvailableResource"),
pulumi.String("DescribeRegions"),
pulumi.String("DescribeZones"),
},
},
&alicloud.OpenApiExplorerApiMcpServerApiArgs{
ApiVersion: pulumi.String("2017-03-21"),
Product: pulumi.String("vod"),
Selectors: pulumi.StringArray{
pulumi.String("CreateUploadVideo"),
},
},
&alicloud.OpenApiExplorerApiMcpServerApiArgs{
ApiVersion: pulumi.String("2014-05-15"),
Product: pulumi.String("Slb"),
Selectors: pulumi.StringArray{
pulumi.String("DescribeAvailableResource"),
},
},
},
Instructions: pulumi.String("Describes the role of the entire MCP Server"),
AdditionalApiDescriptions: alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArray{
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs{
ApiVersion: pulumi.String("2014-05-26"),
EnableOutputSchema: pulumi.Bool(true),
ApiName: pulumi.String("DescribeAvailableResource"),
ConstParameters: alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArray{
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs{
Value: pulumi.String("cn-hangzhou"),
Key: pulumi.String("x_mcp_region_id"),
},
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs{
Value: pulumi.String("B1"),
Key: pulumi.String("a1"),
},
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs{
Value: pulumi.String("b2"),
Key: pulumi.String("a2"),
},
},
ApiOverrideJson: pulumi.String(json0),
Product: pulumi.String("Ecs"),
ExecuteCliCommand: pulumi.Bool(false),
},
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs{
ApiVersion: pulumi.String("2014-05-26"),
EnableOutputSchema: pulumi.Bool(true),
ApiName: pulumi.String("DescribeRegions"),
Product: pulumi.String("Ecs"),
ExecuteCliCommand: pulumi.Bool(true),
},
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs{
ApiVersion: pulumi.String("2014-05-26"),
EnableOutputSchema: pulumi.Bool(true),
ApiName: pulumi.String("DescribeZones"),
Product: pulumi.String("Ecs"),
ExecuteCliCommand: pulumi.Bool(true),
},
},
VpcWhitelists: pulumi.StringArray{
pulumi.String("vpc-examplea"),
pulumi.String("vpc-exampleb"),
pulumi.String("vpc-examplec"),
},
Name: pulumi.String("my-name"),
Language: pulumi.String("ZH_CN"),
EnableAssumeRole: pulumi.Bool(true),
AssumeRoleExtraPolicy: pulumi.String(json1),
TerraformTools: alicloud.OpenApiExplorerApiMcpServerTerraformToolArray{
&alicloud.OpenApiExplorerApiMcpServerTerraformToolArgs{
Description: pulumi.String("Terraform as tool example"),
Async: pulumi.Bool(true),
DestroyPolicy: pulumi.String("NEVER"),
Code: pulumi.String(`variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
`),
Name: pulumi.String("tfexample"),
},
&alicloud.OpenApiExplorerApiMcpServerTerraformToolArgs{
Description: pulumi.String("Terraform as tool example"),
Async: pulumi.Bool(true),
DestroyPolicy: pulumi.String("NEVER"),
Code: pulumi.String(`variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
`),
Name: pulumi.String("tfexample2"),
},
&alicloud.OpenApiExplorerApiMcpServerTerraformToolArgs{
Description: pulumi.String("Terraform as tool example"),
Async: pulumi.Bool(true),
DestroyPolicy: pulumi.String("NEVER"),
Code: pulumi.String(`variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
`),
Name: pulumi.String("tfexample3"),
},
},
AssumeRoleName: pulumi.String("default-role"),
PublicAccess: pulumi.String("on"),
EnableCustomVpcWhitelist: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "terraform-example";
var @default = new AliCloud.OpenApiExplorerApiMcpServer("default", new()
{
SystemTools = new[]
{
"FetchRamActionDetails",
},
Description = "Create",
Prompts = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgs
{
Description = "Obtain user customization information description",
Content = "Prompt body,{{name}}",
Arguments = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgumentArgs
{
Description = "Name information",
Required = true,
Name = "name",
},
},
Name = "Obtain user customization information",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgs
{
Description = "Obtain user customization information description",
Content = "Prompt text, {{name }}, {{age }}, {{description}}",
Arguments = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgumentArgs
{
Description = "Name information",
Required = true,
Name = "name",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgumentArgs
{
Description = "Age information",
Required = true,
Name = "age",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgumentArgs
{
Description = "Description Information",
Required = true,
Name = "description",
},
},
Name = "Obtain user customization information 1",
},
},
OauthClientId = "123456",
Apis = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerApiArgs
{
ApiVersion = "2014-05-26",
Product = "Ecs",
Selectors = new[]
{
"DescribeAvailableResource",
"DescribeRegions",
"DescribeZones",
},
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerApiArgs
{
ApiVersion = "2017-03-21",
Product = "vod",
Selectors = new[]
{
"CreateUploadVideo",
},
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerApiArgs
{
ApiVersion = "2014-05-15",
Product = "Slb",
Selectors = new[]
{
"DescribeAvailableResource",
},
},
},
Instructions = "Describes the role of the entire MCP Server",
AdditionalApiDescriptions = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs
{
ApiVersion = "2014-05-26",
EnableOutputSchema = true,
ApiName = "DescribeAvailableResource",
ConstParameters = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs
{
Value = "cn-hangzhou",
Key = "x_mcp_region_id",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs
{
Value = "B1",
Key = "a1",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs
{
Value = "b2",
Key = "a2",
},
},
ApiOverrideJson = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["summary"] = "This operation supports querying the list of instances based on different request conditions and associating the query instance details. ",
}),
Product = "Ecs",
ExecuteCliCommand = false,
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs
{
ApiVersion = "2014-05-26",
EnableOutputSchema = true,
ApiName = "DescribeRegions",
Product = "Ecs",
ExecuteCliCommand = true,
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs
{
ApiVersion = "2014-05-26",
EnableOutputSchema = true,
ApiName = "DescribeZones",
Product = "Ecs",
ExecuteCliCommand = true,
},
},
VpcWhitelists = new[]
{
"vpc-examplea",
"vpc-exampleb",
"vpc-examplec",
},
Name = "my-name",
Language = "ZH_CN",
EnableAssumeRole = true,
AssumeRoleExtraPolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Version"] = "1",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Effect"] = "Allow",
["Action"] = new[]
{
"ecs:Describe*",
"vpc:Describe*",
"vpc:List*",
},
["Resource"] = "*",
},
},
}),
TerraformTools = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerTerraformToolArgs
{
Description = "Terraform as tool example",
Async = true,
DestroyPolicy = "NEVER",
Code = @"variable \""name\"" {
default = \""terraform-example\""
}
provider \""alicloud\"" {
region = \""cn-beijing\""
}
resource \""alicloud_vpc\"" \""default\"" {
ipv6_isp = \""BGP\""
description = \""example\""
cidr_block = \""10.0.0.0/8\""
vpc_name = var.name
enable_ipv6 = true
}
",
Name = "tfexample",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerTerraformToolArgs
{
Description = "Terraform as tool example",
Async = true,
DestroyPolicy = "NEVER",
Code = @"variable \""name\"" {
default = \""terraform-example\""
}
provider \""alicloud\"" {
region = \""cn-beijing\""
}
resource \""alicloud_vpc\"" \""default\"" {
ipv6_isp = \""BGP\""
description = \""example\""
cidr_block = \""10.0.0.0/8\""
vpc_name = var.name
enable_ipv6 = true
}
",
Name = "tfexample2",
},
new AliCloud.Inputs.OpenApiExplorerApiMcpServerTerraformToolArgs
{
Description = "Terraform as tool example",
Async = true,
DestroyPolicy = "NEVER",
Code = @"variable \""name\"" {
default = \""terraform-example\""
}
provider \""alicloud\"" {
region = \""cn-beijing\""
}
resource \""alicloud_vpc\"" \""default\"" {
ipv6_isp = \""BGP\""
description = \""example\""
cidr_block = \""10.0.0.0/8\""
vpc_name = var.name
enable_ipv6 = true
}
",
Name = "tfexample3",
},
},
AssumeRoleName = "default-role",
PublicAccess = "on",
EnableCustomVpcWhitelist = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.OpenApiExplorerApiMcpServer;
import com.pulumi.alicloud.OpenApiExplorerApiMcpServerArgs;
import com.pulumi.alicloud.inputs.OpenApiExplorerApiMcpServerPromptArgs;
import com.pulumi.alicloud.inputs.OpenApiExplorerApiMcpServerApiArgs;
import com.pulumi.alicloud.inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs;
import com.pulumi.alicloud.inputs.OpenApiExplorerApiMcpServerTerraformToolArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("terraform-example");
var default_ = new OpenApiExplorerApiMcpServer("default", OpenApiExplorerApiMcpServerArgs.builder()
.systemTools("FetchRamActionDetails")
.description("Create")
.prompts(
OpenApiExplorerApiMcpServerPromptArgs.builder()
.description("Obtain user customization information description")
.content("Prompt body,{{name}}")
.arguments(OpenApiExplorerApiMcpServerPromptArgumentArgs.builder()
.description("Name information")
.required(true)
.name("name")
.build())
.name("Obtain user customization information")
.build(),
OpenApiExplorerApiMcpServerPromptArgs.builder()
.description("Obtain user customization information description")
.content("Prompt text, {{name }}, {{age }}, {{description}}")
.arguments(
OpenApiExplorerApiMcpServerPromptArgumentArgs.builder()
.description("Name information")
.required(true)
.name("name")
.build(),
OpenApiExplorerApiMcpServerPromptArgumentArgs.builder()
.description("Age information")
.required(true)
.name("age")
.build(),
OpenApiExplorerApiMcpServerPromptArgumentArgs.builder()
.description("Description Information")
.required(true)
.name("description")
.build())
.name("Obtain user customization information 1")
.build())
.oauthClientId("123456")
.apis(
OpenApiExplorerApiMcpServerApiArgs.builder()
.apiVersion("2014-05-26")
.product("Ecs")
.selectors(
"DescribeAvailableResource",
"DescribeRegions",
"DescribeZones")
.build(),
OpenApiExplorerApiMcpServerApiArgs.builder()
.apiVersion("2017-03-21")
.product("vod")
.selectors("CreateUploadVideo")
.build(),
OpenApiExplorerApiMcpServerApiArgs.builder()
.apiVersion("2014-05-15")
.product("Slb")
.selectors("DescribeAvailableResource")
.build())
.instructions("Describes the role of the entire MCP Server")
.additionalApiDescriptions(
OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs.builder()
.apiVersion("2014-05-26")
.enableOutputSchema(true)
.apiName("DescribeAvailableResource")
.constParameters(
OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs.builder()
.value("cn-hangzhou")
.key("x_mcp_region_id")
.build(),
OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs.builder()
.value("B1")
.key("a1")
.build(),
OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs.builder()
.value("b2")
.key("a2")
.build())
.apiOverrideJson(serializeJson(
jsonObject(
jsonProperty("summary", "This operation supports querying the list of instances based on different request conditions and associating the query instance details. ")
)))
.product("Ecs")
.executeCliCommand(false)
.build(),
OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs.builder()
.apiVersion("2014-05-26")
.enableOutputSchema(true)
.apiName("DescribeRegions")
.product("Ecs")
.executeCliCommand(true)
.build(),
OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs.builder()
.apiVersion("2014-05-26")
.enableOutputSchema(true)
.apiName("DescribeZones")
.product("Ecs")
.executeCliCommand(true)
.build())
.vpcWhitelists(
"vpc-examplea",
"vpc-exampleb",
"vpc-examplec")
.name("my-name")
.language("ZH_CN")
.enableAssumeRole(true)
.assumeRoleExtraPolicy(serializeJson(
jsonObject(
jsonProperty("Version", "1"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Effect", "Allow"),
jsonProperty("Action", jsonArray(
"ecs:Describe*",
"vpc:Describe*",
"vpc:List*"
)),
jsonProperty("Resource", "*")
)))
)))
.terraformTools(
OpenApiExplorerApiMcpServerTerraformToolArgs.builder()
.description("Terraform as tool example")
.async(true)
.destroyPolicy("NEVER")
.code("""
variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
""")
.name("tfexample")
.build(),
OpenApiExplorerApiMcpServerTerraformToolArgs.builder()
.description("Terraform as tool example")
.async(true)
.destroyPolicy("NEVER")
.code("""
variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
""")
.name("tfexample2")
.build(),
OpenApiExplorerApiMcpServerTerraformToolArgs.builder()
.description("Terraform as tool example")
.async(true)
.destroyPolicy("NEVER")
.code("""
variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
""")
.name("tfexample3")
.build())
.assumeRoleName("default-role")
.publicAccess("on")
.enableCustomVpcWhitelist(true)
.build());
}
}
configuration:
name:
type: string
default: terraform-example
resources:
default:
type: alicloud:OpenApiExplorerApiMcpServer
properties:
systemTools:
- FetchRamActionDetails
description: Create
prompts:
- description: Obtain user customization information description
content: Prompt body,{{name}}
arguments:
- description: Name information
required: true
name: name
name: Obtain user customization information
- description: Obtain user customization information description
content: Prompt text, {{name }}, {{age }}, {{description}}
arguments:
- description: Name information
required: true
name: name
- description: Age information
required: true
name: age
- description: Description Information
required: true
name: description
name: Obtain user customization information 1
oauthClientId: '123456'
apis:
- apiVersion: 2014-05-26
product: Ecs
selectors:
- DescribeAvailableResource
- DescribeRegions
- DescribeZones
- apiVersion: 2017-03-21
product: vod
selectors:
- CreateUploadVideo
- apiVersion: 2014-05-15
product: Slb
selectors:
- DescribeAvailableResource
instructions: Describes the role of the entire MCP Server
additionalApiDescriptions:
- apiVersion: 2014-05-26
enableOutputSchema: true
apiName: DescribeAvailableResource
constParameters:
- value: cn-hangzhou
key: x_mcp_region_id
- value: B1
key: a1
- value: b2
key: a2
apiOverrideJson:
fn::toJSON:
summary: 'This operation supports querying the list of instances based on different request conditions and associating the query instance details. '
product: Ecs
executeCliCommand: false
- apiVersion: 2014-05-26
enableOutputSchema: true
apiName: DescribeRegions
product: Ecs
executeCliCommand: true
- apiVersion: 2014-05-26
enableOutputSchema: true
apiName: DescribeZones
product: Ecs
executeCliCommand: true
vpcWhitelists:
- vpc-examplea
- vpc-exampleb
- vpc-examplec
name: my-name
language: ZH_CN
enableAssumeRole: true
assumeRoleExtraPolicy:
fn::toJSON:
Version: '1'
Statement:
- Effect: Allow
Action:
- ecs:Describe*
- vpc:Describe*
- vpc:List*
Resource: '*'
terraformTools:
- description: Terraform as tool example
async: true
destroyPolicy: NEVER
code: |
variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
name: tfexample
- description: Terraform as tool example
async: true
destroyPolicy: NEVER
code: |
variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
name: tfexample2
- description: Terraform as tool example
async: true
destroyPolicy: NEVER
code: |
variable \"name\" {
default = \"terraform-example\"
}
provider \"alicloud\" {
region = \"cn-beijing\"
}
resource \"alicloud_vpc\" \"default\" {
ipv6_isp = \"BGP\"
description = \"example\"
cidr_block = \"10.0.0.0/8\"
vpc_name = var.name
enable_ipv6 = true
}
name: tfexample3
assumeRoleName: default-role
publicAccess: on
enableCustomVpcWhitelist: true
📚 Need more examples? VIEW MORE EXAMPLES
Create OpenApiExplorerApiMcpServer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OpenApiExplorerApiMcpServer(name: string, args: OpenApiExplorerApiMcpServerArgs, opts?: CustomResourceOptions);@overload
def OpenApiExplorerApiMcpServer(resource_name: str,
args: OpenApiExplorerApiMcpServerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OpenApiExplorerApiMcpServer(resource_name: str,
opts: Optional[ResourceOptions] = None,
apis: Optional[Sequence[OpenApiExplorerApiMcpServerApiArgs]] = None,
language: Optional[str] = None,
prompts: Optional[Sequence[OpenApiExplorerApiMcpServerPromptArgs]] = None,
assume_role_name: Optional[str] = None,
description: Optional[str] = None,
enable_assume_role: Optional[bool] = None,
enable_custom_vpc_whitelist: Optional[bool] = None,
assume_role_extra_policy: Optional[str] = None,
name: Optional[str] = None,
instructions: Optional[str] = None,
oauth_client_id: Optional[str] = None,
additional_api_descriptions: Optional[Sequence[OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs]] = None,
public_access: Optional[str] = None,
system_tools: Optional[Sequence[str]] = None,
terraform_tools: Optional[Sequence[OpenApiExplorerApiMcpServerTerraformToolArgs]] = None,
vpc_whitelists: Optional[Sequence[str]] = None)func NewOpenApiExplorerApiMcpServer(ctx *Context, name string, args OpenApiExplorerApiMcpServerArgs, opts ...ResourceOption) (*OpenApiExplorerApiMcpServer, error)public OpenApiExplorerApiMcpServer(string name, OpenApiExplorerApiMcpServerArgs args, CustomResourceOptions? opts = null)
public OpenApiExplorerApiMcpServer(String name, OpenApiExplorerApiMcpServerArgs args)
public OpenApiExplorerApiMcpServer(String name, OpenApiExplorerApiMcpServerArgs args, CustomResourceOptions options)
type: alicloud:OpenApiExplorerApiMcpServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OpenApiExplorerApiMcpServerArgs
- 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 OpenApiExplorerApiMcpServerArgs
- 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 OpenApiExplorerApiMcpServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OpenApiExplorerApiMcpServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OpenApiExplorerApiMcpServerArgs
- 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 openApiExplorerApiMcpServerResource = new AliCloud.OpenApiExplorerApiMcpServer("openApiExplorerApiMcpServerResource", new()
{
Apis = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerApiArgs
{
ApiVersion = "string",
Product = "string",
Selectors = new[]
{
"string",
},
},
},
Language = "string",
Prompts = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgs
{
Arguments = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerPromptArgumentArgs
{
Description = "string",
Name = "string",
Required = false,
},
},
Content = "string",
Description = "string",
Name = "string",
},
},
AssumeRoleName = "string",
Description = "string",
EnableAssumeRole = false,
EnableCustomVpcWhitelist = false,
AssumeRoleExtraPolicy = "string",
Name = "string",
Instructions = "string",
OauthClientId = "string",
AdditionalApiDescriptions = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs
{
ApiName = "string",
ApiOverrideJson = "string",
ApiVersion = "string",
ConstParameters = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs
{
Key = "string",
Value = "string",
},
},
EnableOutputSchema = false,
ExecuteCliCommand = false,
Product = "string",
},
},
PublicAccess = "string",
SystemTools = new[]
{
"string",
},
TerraformTools = new[]
{
new AliCloud.Inputs.OpenApiExplorerApiMcpServerTerraformToolArgs
{
Async = false,
Code = "string",
Description = "string",
DestroyPolicy = "string",
Name = "string",
},
},
VpcWhitelists = new[]
{
"string",
},
});
example, err := alicloud.NewOpenApiExplorerApiMcpServer(ctx, "openApiExplorerApiMcpServerResource", &alicloud.OpenApiExplorerApiMcpServerArgs{
Apis: alicloud.OpenApiExplorerApiMcpServerApiArray{
&alicloud.OpenApiExplorerApiMcpServerApiArgs{
ApiVersion: pulumi.String("string"),
Product: pulumi.String("string"),
Selectors: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Language: pulumi.String("string"),
Prompts: alicloud.OpenApiExplorerApiMcpServerPromptArray{
&alicloud.OpenApiExplorerApiMcpServerPromptArgs{
Arguments: alicloud.OpenApiExplorerApiMcpServerPromptArgumentArray{
&alicloud.OpenApiExplorerApiMcpServerPromptArgumentArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Required: pulumi.Bool(false),
},
},
Content: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
AssumeRoleName: pulumi.String("string"),
Description: pulumi.String("string"),
EnableAssumeRole: pulumi.Bool(false),
EnableCustomVpcWhitelist: pulumi.Bool(false),
AssumeRoleExtraPolicy: pulumi.String("string"),
Name: pulumi.String("string"),
Instructions: pulumi.String("string"),
OauthClientId: pulumi.String("string"),
AdditionalApiDescriptions: alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArray{
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs{
ApiName: pulumi.String("string"),
ApiOverrideJson: pulumi.String("string"),
ApiVersion: pulumi.String("string"),
ConstParameters: alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArray{
&alicloud.OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
EnableOutputSchema: pulumi.Bool(false),
ExecuteCliCommand: pulumi.Bool(false),
Product: pulumi.String("string"),
},
},
PublicAccess: pulumi.String("string"),
SystemTools: pulumi.StringArray{
pulumi.String("string"),
},
TerraformTools: alicloud.OpenApiExplorerApiMcpServerTerraformToolArray{
&alicloud.OpenApiExplorerApiMcpServerTerraformToolArgs{
Async: pulumi.Bool(false),
Code: pulumi.String("string"),
Description: pulumi.String("string"),
DestroyPolicy: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
VpcWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
})
var openApiExplorerApiMcpServerResource = new OpenApiExplorerApiMcpServer("openApiExplorerApiMcpServerResource", OpenApiExplorerApiMcpServerArgs.builder()
.apis(OpenApiExplorerApiMcpServerApiArgs.builder()
.apiVersion("string")
.product("string")
.selectors("string")
.build())
.language("string")
.prompts(OpenApiExplorerApiMcpServerPromptArgs.builder()
.arguments(OpenApiExplorerApiMcpServerPromptArgumentArgs.builder()
.description("string")
.name("string")
.required(false)
.build())
.content("string")
.description("string")
.name("string")
.build())
.assumeRoleName("string")
.description("string")
.enableAssumeRole(false)
.enableCustomVpcWhitelist(false)
.assumeRoleExtraPolicy("string")
.name("string")
.instructions("string")
.oauthClientId("string")
.additionalApiDescriptions(OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs.builder()
.apiName("string")
.apiOverrideJson("string")
.apiVersion("string")
.constParameters(OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs.builder()
.key("string")
.value("string")
.build())
.enableOutputSchema(false)
.executeCliCommand(false)
.product("string")
.build())
.publicAccess("string")
.systemTools("string")
.terraformTools(OpenApiExplorerApiMcpServerTerraformToolArgs.builder()
.async(false)
.code("string")
.description("string")
.destroyPolicy("string")
.name("string")
.build())
.vpcWhitelists("string")
.build());
open_api_explorer_api_mcp_server_resource = alicloud.OpenApiExplorerApiMcpServer("openApiExplorerApiMcpServerResource",
apis=[{
"api_version": "string",
"product": "string",
"selectors": ["string"],
}],
language="string",
prompts=[{
"arguments": [{
"description": "string",
"name": "string",
"required": False,
}],
"content": "string",
"description": "string",
"name": "string",
}],
assume_role_name="string",
description="string",
enable_assume_role=False,
enable_custom_vpc_whitelist=False,
assume_role_extra_policy="string",
name="string",
instructions="string",
oauth_client_id="string",
additional_api_descriptions=[{
"api_name": "string",
"api_override_json": "string",
"api_version": "string",
"const_parameters": [{
"key": "string",
"value": "string",
}],
"enable_output_schema": False,
"execute_cli_command": False,
"product": "string",
}],
public_access="string",
system_tools=["string"],
terraform_tools=[{
"async_": False,
"code": "string",
"description": "string",
"destroy_policy": "string",
"name": "string",
}],
vpc_whitelists=["string"])
const openApiExplorerApiMcpServerResource = new alicloud.OpenApiExplorerApiMcpServer("openApiExplorerApiMcpServerResource", {
apis: [{
apiVersion: "string",
product: "string",
selectors: ["string"],
}],
language: "string",
prompts: [{
arguments: [{
description: "string",
name: "string",
required: false,
}],
content: "string",
description: "string",
name: "string",
}],
assumeRoleName: "string",
description: "string",
enableAssumeRole: false,
enableCustomVpcWhitelist: false,
assumeRoleExtraPolicy: "string",
name: "string",
instructions: "string",
oauthClientId: "string",
additionalApiDescriptions: [{
apiName: "string",
apiOverrideJson: "string",
apiVersion: "string",
constParameters: [{
key: "string",
value: "string",
}],
enableOutputSchema: false,
executeCliCommand: false,
product: "string",
}],
publicAccess: "string",
systemTools: ["string"],
terraformTools: [{
async: false,
code: "string",
description: "string",
destroyPolicy: "string",
name: "string",
}],
vpcWhitelists: ["string"],
});
type: alicloud:OpenApiExplorerApiMcpServer
properties:
additionalApiDescriptions:
- apiName: string
apiOverrideJson: string
apiVersion: string
constParameters:
- key: string
value: string
enableOutputSchema: false
executeCliCommand: false
product: string
apis:
- apiVersion: string
product: string
selectors:
- string
assumeRoleExtraPolicy: string
assumeRoleName: string
description: string
enableAssumeRole: false
enableCustomVpcWhitelist: false
instructions: string
language: string
name: string
oauthClientId: string
prompts:
- arguments:
- description: string
name: string
required: false
content: string
description: string
name: string
publicAccess: string
systemTools:
- string
terraformTools:
- async: false
code: string
description: string
destroyPolicy: string
name: string
vpcWhitelists:
- string
OpenApiExplorerApiMcpServer 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 OpenApiExplorerApiMcpServer resource accepts the following input properties:
- Apis
List<Pulumi.
Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Api> - The list of APIs to be included in the API MCP Server. See
apisbelow. - Additional
Api List<Pulumi.Descriptions Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Additional Api Description> - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- Assume
Role stringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- Assume
Role stringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- Description string
- Description of the API MCP service.
- Enable
Assume boolRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- Enable
Custom boolVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- Instructions string
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- Language string
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- Name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- Oauth
Client stringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - Prompts
List<Pulumi.
Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Prompt> - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - Public
Access string - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- System
Tools List<string> - Enabled system services.
- Terraform
Tools List<Pulumi.Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Terraform Tool> - Vpc
Whitelists List<string> - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- Apis
[]Open
Api Explorer Api Mcp Server Api Args - The list of APIs to be included in the API MCP Server. See
apisbelow. - Additional
Api []OpenDescriptions Api Explorer Api Mcp Server Additional Api Description Args - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- Assume
Role stringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- Assume
Role stringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- Description string
- Description of the API MCP service.
- Enable
Assume boolRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- Enable
Custom boolVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- Instructions string
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- Language string
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- Name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- Oauth
Client stringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - Prompts
[]Open
Api Explorer Api Mcp Server Prompt Args - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - Public
Access string - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- System
Tools []string - Enabled system services.
- Terraform
Tools []OpenApi Explorer Api Mcp Server Terraform Tool Args - Vpc
Whitelists []string - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- apis
List<Open
Api Explorer Api Mcp Server Api> - The list of APIs to be included in the API MCP Server. See
apisbelow. - additional
Api List<OpenDescriptions Api Explorer Api Mcp Server Additional Api Description> - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- assume
Role StringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume
Role StringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- description String
- Description of the API MCP service.
- enable
Assume BooleanRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable
Custom BooleanVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions String
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language String
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name String
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth
Client StringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts
List<Open
Api Explorer Api Mcp Server Prompt> - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public
Access String - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system
Tools List<String> - Enabled system services.
- terraform
Tools List<OpenApi Explorer Api Mcp Server Terraform Tool> - vpc
Whitelists List<String> - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- apis
Open
Api Explorer Api Mcp Server Api[] - The list of APIs to be included in the API MCP Server. See
apisbelow. - additional
Api OpenDescriptions Api Explorer Api Mcp Server Additional Api Description[] - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- assume
Role stringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume
Role stringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- description string
- Description of the API MCP service.
- enable
Assume booleanRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable
Custom booleanVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions string
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language string
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth
Client stringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts
Open
Api Explorer Api Mcp Server Prompt[] - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public
Access string - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system
Tools string[] - Enabled system services.
- terraform
Tools OpenApi Explorer Api Mcp Server Terraform Tool[] - vpc
Whitelists string[] - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- apis
Sequence[Open
Api Explorer Api Mcp Server Api Args] - The list of APIs to be included in the API MCP Server. See
apisbelow. - additional_
api_ Sequence[Opendescriptions Api Explorer Api Mcp Server Additional Api Description Args] - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- assume_
role_ strextra_ policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume_
role_ strname - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- description str
- Description of the API MCP service.
- enable_
assume_ boolrole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable_
custom_ boolvpc_ whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions str
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language str
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name str
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth_
client_ strid - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts
Sequence[Open
Api Explorer Api Mcp Server Prompt Args] - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public_
access str - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system_
tools Sequence[str] - Enabled system services.
- terraform_
tools Sequence[OpenApi Explorer Api Mcp Server Terraform Tool Args] - vpc_
whitelists Sequence[str] - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- apis List<Property Map>
- The list of APIs to be included in the API MCP Server. See
apisbelow. - additional
Api List<Property Map>Descriptions - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- assume
Role StringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume
Role StringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- description String
- Description of the API MCP service.
- enable
Assume BooleanRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable
Custom BooleanVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions String
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language String
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name String
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth
Client StringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts List<Property Map>
- List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public
Access String - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system
Tools List<String> - Enabled system services.
- terraform
Tools List<Property Map> - vpc
Whitelists List<String> - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
Outputs
All input properties are implicitly available as output properties. Additionally, the OpenApiExplorerApiMcpServer resource produces the following output properties:
- Create
Time string - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- Id string
- The provider-assigned unique ID for this managed resource.
- Create
Time string - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- Id string
- The provider-assigned unique ID for this managed resource.
- create
Time String - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- id String
- The provider-assigned unique ID for this managed resource.
- create
Time string - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- id string
- The provider-assigned unique ID for this managed resource.
- create_
time str - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- id str
- The provider-assigned unique ID for this managed resource.
- create
Time String - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing OpenApiExplorerApiMcpServer Resource
Get an existing OpenApiExplorerApiMcpServer 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?: OpenApiExplorerApiMcpServerState, opts?: CustomResourceOptions): OpenApiExplorerApiMcpServer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_api_descriptions: Optional[Sequence[OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs]] = None,
apis: Optional[Sequence[OpenApiExplorerApiMcpServerApiArgs]] = None,
assume_role_extra_policy: Optional[str] = None,
assume_role_name: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
enable_assume_role: Optional[bool] = None,
enable_custom_vpc_whitelist: Optional[bool] = None,
instructions: Optional[str] = None,
language: Optional[str] = None,
name: Optional[str] = None,
oauth_client_id: Optional[str] = None,
prompts: Optional[Sequence[OpenApiExplorerApiMcpServerPromptArgs]] = None,
public_access: Optional[str] = None,
system_tools: Optional[Sequence[str]] = None,
terraform_tools: Optional[Sequence[OpenApiExplorerApiMcpServerTerraformToolArgs]] = None,
vpc_whitelists: Optional[Sequence[str]] = None) -> OpenApiExplorerApiMcpServerfunc GetOpenApiExplorerApiMcpServer(ctx *Context, name string, id IDInput, state *OpenApiExplorerApiMcpServerState, opts ...ResourceOption) (*OpenApiExplorerApiMcpServer, error)public static OpenApiExplorerApiMcpServer Get(string name, Input<string> id, OpenApiExplorerApiMcpServerState? state, CustomResourceOptions? opts = null)public static OpenApiExplorerApiMcpServer get(String name, Output<String> id, OpenApiExplorerApiMcpServerState state, CustomResourceOptions options)resources: _: type: alicloud:OpenApiExplorerApiMcpServer get: 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.
- Additional
Api List<Pulumi.Descriptions Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Additional Api Description> - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- Apis
List<Pulumi.
Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Api> - The list of APIs to be included in the API MCP Server. See
apisbelow. - Assume
Role stringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- Assume
Role stringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- Create
Time string - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- Description string
- Description of the API MCP service.
- Enable
Assume boolRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- Enable
Custom boolVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- Instructions string
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- Language string
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- Name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- Oauth
Client stringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - Prompts
List<Pulumi.
Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Prompt> - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - Public
Access string - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- System
Tools List<string> - Enabled system services.
- Terraform
Tools List<Pulumi.Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Terraform Tool> - Vpc
Whitelists List<string> - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- Additional
Api []OpenDescriptions Api Explorer Api Mcp Server Additional Api Description Args - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- Apis
[]Open
Api Explorer Api Mcp Server Api Args - The list of APIs to be included in the API MCP Server. See
apisbelow. - Assume
Role stringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- Assume
Role stringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- Create
Time string - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- Description string
- Description of the API MCP service.
- Enable
Assume boolRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- Enable
Custom boolVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- Instructions string
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- Language string
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- Name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- Oauth
Client stringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - Prompts
[]Open
Api Explorer Api Mcp Server Prompt Args - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - Public
Access string - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- System
Tools []string - Enabled system services.
- Terraform
Tools []OpenApi Explorer Api Mcp Server Terraform Tool Args - Vpc
Whitelists []string - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- additional
Api List<OpenDescriptions Api Explorer Api Mcp Server Additional Api Description> - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- apis
List<Open
Api Explorer Api Mcp Server Api> - The list of APIs to be included in the API MCP Server. See
apisbelow. - assume
Role StringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume
Role StringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- create
Time String - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- description String
- Description of the API MCP service.
- enable
Assume BooleanRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable
Custom BooleanVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions String
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language String
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name String
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth
Client StringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts
List<Open
Api Explorer Api Mcp Server Prompt> - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public
Access String - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system
Tools List<String> - Enabled system services.
- terraform
Tools List<OpenApi Explorer Api Mcp Server Terraform Tool> - vpc
Whitelists List<String> - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- additional
Api OpenDescriptions Api Explorer Api Mcp Server Additional Api Description[] - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- apis
Open
Api Explorer Api Mcp Server Api[] - The list of APIs to be included in the API MCP Server. See
apisbelow. - assume
Role stringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume
Role stringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- create
Time string - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- description string
- Description of the API MCP service.
- enable
Assume booleanRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable
Custom booleanVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions string
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language string
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth
Client stringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts
Open
Api Explorer Api Mcp Server Prompt[] - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public
Access string - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system
Tools string[] - Enabled system services.
- terraform
Tools OpenApi Explorer Api Mcp Server Terraform Tool[] - vpc
Whitelists string[] - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- additional_
api_ Sequence[Opendescriptions Api Explorer Api Mcp Server Additional Api Description Args] - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- apis
Sequence[Open
Api Explorer Api Mcp Server Api Args] - The list of APIs to be included in the API MCP Server. See
apisbelow. - assume_
role_ strextra_ policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume_
role_ strname - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- create_
time str - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- description str
- Description of the API MCP service.
- enable_
assume_ boolrole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable_
custom_ boolvpc_ whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions str
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language str
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name str
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth_
client_ strid - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts
Sequence[Open
Api Explorer Api Mcp Server Prompt Args] - List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public_
access str - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system_
tools Sequence[str] - Enabled system services.
- terraform_
tools Sequence[OpenApi Explorer Api Mcp Server Terraform Tool Args] - vpc_
whitelists Sequence[str] - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
- additional
Api List<Property Map>Descriptions - Additional OpenAPI description information that can override the default behavior of APIs, including:
- API name
- Modification or removal of API parameter names
- Whether to exclude the API from the output API response structure definition
- Whether to return a CLI execution command instead of directly executing the API
- Configuration of constant values for API parameters; parameters set as constants will not have their definitions returned in the tool list See
additional_api_descriptionsbelow.
- apis List<Property Map>
- The list of APIs to be included in the API MCP Server. See
apisbelow. - assume
Role StringExtra Policy - When multi-account access is enabled, this field defines an additional policy for role assumption. If specified, this policy overrides the original permissions defined for the role, and the assumed role’s permissions are determined solely by this policy.
- assume
Role StringName - The name of the RAM role in the target account to assume when enabling multi-account access for cross-account operations.
- create
Time String - MCP Server creation time in China Standard Time (CST), for example, 2025-12-04 19:46:52.
- description String
- Description of the API MCP service.
- enable
Assume BooleanRole - Specifies whether to enable multi-account access. When enabled, the MCP Server exposes the x_assume_account_id parameter by default. When this parameter is provided, the MCP Server switches to the specified account to perform operations.
- enable
Custom BooleanVpc Whitelist - Whether to enable a custom VPC whitelist. If disabled, the configuration follows the account-level setting.
- instructions String
- MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field defined in the MCP standard protocol.
- language String
- Documentation language for the API MCP service. You can select either Chinese or English API documentation. The choice of language may affect the AI's response quality due to differences in prompt wording. Supported values are EN_US and ZH_CN.
- name String
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- oauth
Client StringId - The custom OAuth Client ID when selecting a custom OAuth configuration.
Supported only for Web/Native applications, and the OAuth scope must include /acs/mcp-server. - prompts List<Property Map>
- List of prompts supported by the MCP Server. For the MCP protocol, clients retrieve this list through the prompts/list RPC call. See
promptsbelow. - public
Access String - Whether to enable public network access. This setting takes precedence over the account-level configuration and supports the following options:
- on: enables public network access;
- off: disables public network access;
- follow: inherits the account-level configuration.
- system
Tools List<String> - Enabled system services.
- terraform
Tools List<Property Map> - vpc
Whitelists List<String> - When public network access is disabled, this field specifies the VPC whitelist that restricts source VPCs. If not set or left empty, no restriction is applied to the source.
Supporting Types
OpenApiExplorerApiMcpServerAdditionalApiDescription, OpenApiExplorerApiMcpServerAdditionalApiDescriptionArgs
- Api
Name string - The API name, such as ListApiMcpServers.
- Api
Override stringJson API structure definition information. You can use this parameter to directly modify the API description and parameter list. You can obtain the API definition information from an API endpoint such as https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json.
NOTE: Note that required parameters must not be removed; otherwise, calls by the large model will continuously fail due to missing required parameters.>
- Api
Version string - API version information, typically in date format, such as 2014-05-26.
- Const
Parameters List<Pulumi.Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Additional Api Description Const Parameter> - Constant configuration information. When the MCP Server needs to fix certain tool parameters to specific values, you can configure this parameter to enforce those fixed values.
Parameters configured as constants will not be returned as tool parameters through the MCP protocol. Large models cannot define these parameters. During execution, the MCP Server merges these constant values into the API call parameters. Seeconst_parametersbelow. - Enable
Output boolSchema By default, this feature is disabled, and the MCP Server returns only the structure definition of input parameters. When enabled, the MCP Server returns the output parameter structure definition via the MCP protocol.
NOTE: The output parameter structure may be complex. Enabling this feature significantly increases the MCP context size. Use this feature with caution.>
- Execute
Cli boolCommand Call interception. When this parameter is enabled, the MCP Server returns the complete CLI command name instead of directly executing the API call. Use this option when the API call is long-running or requires interaction with local files. The MCP Server enforces theoretical time limits for single-tool invocations:
- SSE protocol: up to 30 minutes
- Streamable HTTP protocol: up to 1 minute
For tools whose single API execution exceeds 30 minutes, we recommend enabling this parameter. Install the CLI and complete account authentication on the machine initiating the call, then combine it with this tool for optimal results.
NOTE: The identity used to execute the CLI differs from the identity used by the MCP Server. Pay attention to the associated security risks.>
- Product string
- The name of the cloud product, such as Ecs.
- Api
Name string - The API name, such as ListApiMcpServers.
- Api
Override stringJson API structure definition information. You can use this parameter to directly modify the API description and parameter list. You can obtain the API definition information from an API endpoint such as https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json.
NOTE: Note that required parameters must not be removed; otherwise, calls by the large model will continuously fail due to missing required parameters.>
- Api
Version string - API version information, typically in date format, such as 2014-05-26.
- Const
Parameters []OpenApi Explorer Api Mcp Server Additional Api Description Const Parameter - Constant configuration information. When the MCP Server needs to fix certain tool parameters to specific values, you can configure this parameter to enforce those fixed values.
Parameters configured as constants will not be returned as tool parameters through the MCP protocol. Large models cannot define these parameters. During execution, the MCP Server merges these constant values into the API call parameters. Seeconst_parametersbelow. - Enable
Output boolSchema By default, this feature is disabled, and the MCP Server returns only the structure definition of input parameters. When enabled, the MCP Server returns the output parameter structure definition via the MCP protocol.
NOTE: The output parameter structure may be complex. Enabling this feature significantly increases the MCP context size. Use this feature with caution.>
- Execute
Cli boolCommand Call interception. When this parameter is enabled, the MCP Server returns the complete CLI command name instead of directly executing the API call. Use this option when the API call is long-running or requires interaction with local files. The MCP Server enforces theoretical time limits for single-tool invocations:
- SSE protocol: up to 30 minutes
- Streamable HTTP protocol: up to 1 minute
For tools whose single API execution exceeds 30 minutes, we recommend enabling this parameter. Install the CLI and complete account authentication on the machine initiating the call, then combine it with this tool for optimal results.
NOTE: The identity used to execute the CLI differs from the identity used by the MCP Server. Pay attention to the associated security risks.>
- Product string
- The name of the cloud product, such as Ecs.
- api
Name String - The API name, such as ListApiMcpServers.
- api
Override StringJson API structure definition information. You can use this parameter to directly modify the API description and parameter list. You can obtain the API definition information from an API endpoint such as https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json.
NOTE: Note that required parameters must not be removed; otherwise, calls by the large model will continuously fail due to missing required parameters.>
- api
Version String - API version information, typically in date format, such as 2014-05-26.
- const
Parameters List<OpenApi Explorer Api Mcp Server Additional Api Description Const Parameter> - Constant configuration information. When the MCP Server needs to fix certain tool parameters to specific values, you can configure this parameter to enforce those fixed values.
Parameters configured as constants will not be returned as tool parameters through the MCP protocol. Large models cannot define these parameters. During execution, the MCP Server merges these constant values into the API call parameters. Seeconst_parametersbelow. - enable
Output BooleanSchema By default, this feature is disabled, and the MCP Server returns only the structure definition of input parameters. When enabled, the MCP Server returns the output parameter structure definition via the MCP protocol.
NOTE: The output parameter structure may be complex. Enabling this feature significantly increases the MCP context size. Use this feature with caution.>
- execute
Cli BooleanCommand Call interception. When this parameter is enabled, the MCP Server returns the complete CLI command name instead of directly executing the API call. Use this option when the API call is long-running or requires interaction with local files. The MCP Server enforces theoretical time limits for single-tool invocations:
- SSE protocol: up to 30 minutes
- Streamable HTTP protocol: up to 1 minute
For tools whose single API execution exceeds 30 minutes, we recommend enabling this parameter. Install the CLI and complete account authentication on the machine initiating the call, then combine it with this tool for optimal results.
NOTE: The identity used to execute the CLI differs from the identity used by the MCP Server. Pay attention to the associated security risks.>
- product String
- The name of the cloud product, such as Ecs.
- api
Name string - The API name, such as ListApiMcpServers.
- api
Override stringJson API structure definition information. You can use this parameter to directly modify the API description and parameter list. You can obtain the API definition information from an API endpoint such as https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json.
NOTE: Note that required parameters must not be removed; otherwise, calls by the large model will continuously fail due to missing required parameters.>
- api
Version string - API version information, typically in date format, such as 2014-05-26.
- const
Parameters OpenApi Explorer Api Mcp Server Additional Api Description Const Parameter[] - Constant configuration information. When the MCP Server needs to fix certain tool parameters to specific values, you can configure this parameter to enforce those fixed values.
Parameters configured as constants will not be returned as tool parameters through the MCP protocol. Large models cannot define these parameters. During execution, the MCP Server merges these constant values into the API call parameters. Seeconst_parametersbelow. - enable
Output booleanSchema By default, this feature is disabled, and the MCP Server returns only the structure definition of input parameters. When enabled, the MCP Server returns the output parameter structure definition via the MCP protocol.
NOTE: The output parameter structure may be complex. Enabling this feature significantly increases the MCP context size. Use this feature with caution.>
- execute
Cli booleanCommand Call interception. When this parameter is enabled, the MCP Server returns the complete CLI command name instead of directly executing the API call. Use this option when the API call is long-running or requires interaction with local files. The MCP Server enforces theoretical time limits for single-tool invocations:
- SSE protocol: up to 30 minutes
- Streamable HTTP protocol: up to 1 minute
For tools whose single API execution exceeds 30 minutes, we recommend enabling this parameter. Install the CLI and complete account authentication on the machine initiating the call, then combine it with this tool for optimal results.
NOTE: The identity used to execute the CLI differs from the identity used by the MCP Server. Pay attention to the associated security risks.>
- product string
- The name of the cloud product, such as Ecs.
- api_
name str - The API name, such as ListApiMcpServers.
- api_
override_ strjson API structure definition information. You can use this parameter to directly modify the API description and parameter list. You can obtain the API definition information from an API endpoint such as https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json.
NOTE: Note that required parameters must not be removed; otherwise, calls by the large model will continuously fail due to missing required parameters.>
- api_
version str - API version information, typically in date format, such as 2014-05-26.
- const_
parameters Sequence[OpenApi Explorer Api Mcp Server Additional Api Description Const Parameter] - Constant configuration information. When the MCP Server needs to fix certain tool parameters to specific values, you can configure this parameter to enforce those fixed values.
Parameters configured as constants will not be returned as tool parameters through the MCP protocol. Large models cannot define these parameters. During execution, the MCP Server merges these constant values into the API call parameters. Seeconst_parametersbelow. - enable_
output_ boolschema By default, this feature is disabled, and the MCP Server returns only the structure definition of input parameters. When enabled, the MCP Server returns the output parameter structure definition via the MCP protocol.
NOTE: The output parameter structure may be complex. Enabling this feature significantly increases the MCP context size. Use this feature with caution.>
- execute_
cli_ boolcommand Call interception. When this parameter is enabled, the MCP Server returns the complete CLI command name instead of directly executing the API call. Use this option when the API call is long-running or requires interaction with local files. The MCP Server enforces theoretical time limits for single-tool invocations:
- SSE protocol: up to 30 minutes
- Streamable HTTP protocol: up to 1 minute
For tools whose single API execution exceeds 30 minutes, we recommend enabling this parameter. Install the CLI and complete account authentication on the machine initiating the call, then combine it with this tool for optimal results.
NOTE: The identity used to execute the CLI differs from the identity used by the MCP Server. Pay attention to the associated security risks.>
- product str
- The name of the cloud product, such as Ecs.
- api
Name String - The API name, such as ListApiMcpServers.
- api
Override StringJson API structure definition information. You can use this parameter to directly modify the API description and parameter list. You can obtain the API definition information from an API endpoint such as https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json.
NOTE: Note that required parameters must not be removed; otherwise, calls by the large model will continuously fail due to missing required parameters.>
- api
Version String - API version information, typically in date format, such as 2014-05-26.
- const
Parameters List<Property Map> - Constant configuration information. When the MCP Server needs to fix certain tool parameters to specific values, you can configure this parameter to enforce those fixed values.
Parameters configured as constants will not be returned as tool parameters through the MCP protocol. Large models cannot define these parameters. During execution, the MCP Server merges these constant values into the API call parameters. Seeconst_parametersbelow. - enable
Output BooleanSchema By default, this feature is disabled, and the MCP Server returns only the structure definition of input parameters. When enabled, the MCP Server returns the output parameter structure definition via the MCP protocol.
NOTE: The output parameter structure may be complex. Enabling this feature significantly increases the MCP context size. Use this feature with caution.>
- execute
Cli BooleanCommand Call interception. When this parameter is enabled, the MCP Server returns the complete CLI command name instead of directly executing the API call. Use this option when the API call is long-running or requires interaction with local files. The MCP Server enforces theoretical time limits for single-tool invocations:
- SSE protocol: up to 30 minutes
- Streamable HTTP protocol: up to 1 minute
For tools whose single API execution exceeds 30 minutes, we recommend enabling this parameter. Install the CLI and complete account authentication on the machine initiating the call, then combine it with this tool for optimal results.
NOTE: The identity used to execute the CLI differs from the identity used by the MCP Server. Pay attention to the associated security risks.>
- product String
- The name of the cloud product, such as Ecs.
OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameter, OpenApiExplorerApiMcpServerAdditionalApiDescriptionConstParameterArgs
- Key string
Parameter location. Currently, except for ROA-style body parameters (which support up to two levels), nested parameter configurations beyond two levels are not supported. If you need to configure a composite data structure, set the Value to a JSON object.
For RPC-style APIs, examples include:
- Name: sets the Name parameter to a fixed value.
For ROA-style APIs, examples include:
- Name: sets a query or path parameter named Name to a fixed value;
- body.Name: sets the Name field within the request body to a fixed value.
Configurations such as body.Name.Sub are not supported. If you need to set body.Name as a composite structure, specify the Value as a JSON object—for example, {"Sub": "xxx"}.
**NOTE:** x_mcp_region_id is a built-in MCP parameter used to control the region and can also be configured as a fixed value to invoke services in a specified region.>
- Value string
- This property does not have a description in the spec, please add it before generating code.
- Key string
Parameter location. Currently, except for ROA-style body parameters (which support up to two levels), nested parameter configurations beyond two levels are not supported. If you need to configure a composite data structure, set the Value to a JSON object.
For RPC-style APIs, examples include:
- Name: sets the Name parameter to a fixed value.
For ROA-style APIs, examples include:
- Name: sets a query or path parameter named Name to a fixed value;
- body.Name: sets the Name field within the request body to a fixed value.
Configurations such as body.Name.Sub are not supported. If you need to set body.Name as a composite structure, specify the Value as a JSON object—for example, {"Sub": "xxx"}.
**NOTE:** x_mcp_region_id is a built-in MCP parameter used to control the region and can also be configured as a fixed value to invoke services in a specified region.>
- Value string
- This property does not have a description in the spec, please add it before generating code.
- key String
Parameter location. Currently, except for ROA-style body parameters (which support up to two levels), nested parameter configurations beyond two levels are not supported. If you need to configure a composite data structure, set the Value to a JSON object.
For RPC-style APIs, examples include:
- Name: sets the Name parameter to a fixed value.
For ROA-style APIs, examples include:
- Name: sets a query or path parameter named Name to a fixed value;
- body.Name: sets the Name field within the request body to a fixed value.
Configurations such as body.Name.Sub are not supported. If you need to set body.Name as a composite structure, specify the Value as a JSON object—for example, {"Sub": "xxx"}.
**NOTE:** x_mcp_region_id is a built-in MCP parameter used to control the region and can also be configured as a fixed value to invoke services in a specified region.>
- value String
- This property does not have a description in the spec, please add it before generating code.
- key string
Parameter location. Currently, except for ROA-style body parameters (which support up to two levels), nested parameter configurations beyond two levels are not supported. If you need to configure a composite data structure, set the Value to a JSON object.
For RPC-style APIs, examples include:
- Name: sets the Name parameter to a fixed value.
For ROA-style APIs, examples include:
- Name: sets a query or path parameter named Name to a fixed value;
- body.Name: sets the Name field within the request body to a fixed value.
Configurations such as body.Name.Sub are not supported. If you need to set body.Name as a composite structure, specify the Value as a JSON object—for example, {"Sub": "xxx"}.
**NOTE:** x_mcp_region_id is a built-in MCP parameter used to control the region and can also be configured as a fixed value to invoke services in a specified region.>
- value string
- This property does not have a description in the spec, please add it before generating code.
- key str
Parameter location. Currently, except for ROA-style body parameters (which support up to two levels), nested parameter configurations beyond two levels are not supported. If you need to configure a composite data structure, set the Value to a JSON object.
For RPC-style APIs, examples include:
- Name: sets the Name parameter to a fixed value.
For ROA-style APIs, examples include:
- Name: sets a query or path parameter named Name to a fixed value;
- body.Name: sets the Name field within the request body to a fixed value.
Configurations such as body.Name.Sub are not supported. If you need to set body.Name as a composite structure, specify the Value as a JSON object—for example, {"Sub": "xxx"}.
**NOTE:** x_mcp_region_id is a built-in MCP parameter used to control the region and can also be configured as a fixed value to invoke services in a specified region.>
- value str
- This property does not have a description in the spec, please add it before generating code.
- key String
Parameter location. Currently, except for ROA-style body parameters (which support up to two levels), nested parameter configurations beyond two levels are not supported. If you need to configure a composite data structure, set the Value to a JSON object.
For RPC-style APIs, examples include:
- Name: sets the Name parameter to a fixed value.
For ROA-style APIs, examples include:
- Name: sets a query or path parameter named Name to a fixed value;
- body.Name: sets the Name field within the request body to a fixed value.
Configurations such as body.Name.Sub are not supported. If you need to set body.Name as a composite structure, specify the Value as a JSON object—for example, {"Sub": "xxx"}.
**NOTE:** x_mcp_region_id is a built-in MCP parameter used to control the region and can also be configured as a fixed value to invoke services in a specified region.>
- value String
- This property does not have a description in the spec, please add it before generating code.
OpenApiExplorerApiMcpServerApi, OpenApiExplorerApiMcpServerApiArgs
- Api
Version string - API version information, typically in date format—for example, the version for ECS is 2014-05-26.
- Product string
- Product code, such as Ecs.
- Selectors List<string>
- Selectors in array format, where each item is an API name—for example, GetApiDefinition or ListApiDefinitions. You can obtain the complete list of supported APIs from the Alibaba Cloud Developer Portal.
- Api
Version string - API version information, typically in date format—for example, the version for ECS is 2014-05-26.
- Product string
- Product code, such as Ecs.
- Selectors []string
- Selectors in array format, where each item is an API name—for example, GetApiDefinition or ListApiDefinitions. You can obtain the complete list of supported APIs from the Alibaba Cloud Developer Portal.
- api
Version String - API version information, typically in date format—for example, the version for ECS is 2014-05-26.
- product String
- Product code, such as Ecs.
- selectors List<String>
- Selectors in array format, where each item is an API name—for example, GetApiDefinition or ListApiDefinitions. You can obtain the complete list of supported APIs from the Alibaba Cloud Developer Portal.
- api
Version string - API version information, typically in date format—for example, the version for ECS is 2014-05-26.
- product string
- Product code, such as Ecs.
- selectors string[]
- Selectors in array format, where each item is an API name—for example, GetApiDefinition or ListApiDefinitions. You can obtain the complete list of supported APIs from the Alibaba Cloud Developer Portal.
- api_
version str - API version information, typically in date format—for example, the version for ECS is 2014-05-26.
- product str
- Product code, such as Ecs.
- selectors Sequence[str]
- Selectors in array format, where each item is an API name—for example, GetApiDefinition or ListApiDefinitions. You can obtain the complete list of supported APIs from the Alibaba Cloud Developer Portal.
- api
Version String - API version information, typically in date format—for example, the version for ECS is 2014-05-26.
- product String
- Product code, such as Ecs.
- selectors List<String>
- Selectors in array format, where each item is an API name—for example, GetApiDefinition or ListApiDefinitions. You can obtain the complete list of supported APIs from the Alibaba Cloud Developer Portal.
OpenApiExplorerApiMcpServerPrompt, OpenApiExplorerApiMcpServerPromptArgs
- Arguments
List<Pulumi.
Ali Cloud. Inputs. Open Api Explorer Api Mcp Server Prompt Argument> - Parameters for the prompt. See
argumentsbelow. - Content string
- Full content of the prompt, supporting dynamic parameters. Parameters must be defined in Arguments, using the format {{ARG}}, where ARG supports English characters. Example: My name is: {{name}}.
- Description string
- Description of the prompt parameter.
- Name string
- Name of the prompt parameter.
- Arguments
[]Open
Api Explorer Api Mcp Server Prompt Argument - Parameters for the prompt. See
argumentsbelow. - Content string
- Full content of the prompt, supporting dynamic parameters. Parameters must be defined in Arguments, using the format {{ARG}}, where ARG supports English characters. Example: My name is: {{name}}.
- Description string
- Description of the prompt parameter.
- Name string
- Name of the prompt parameter.
- arguments
List<Open
Api Explorer Api Mcp Server Prompt Argument> - Parameters for the prompt. See
argumentsbelow. - content String
- Full content of the prompt, supporting dynamic parameters. Parameters must be defined in Arguments, using the format {{ARG}}, where ARG supports English characters. Example: My name is: {{name}}.
- description String
- Description of the prompt parameter.
- name String
- Name of the prompt parameter.
- arguments
Open
Api Explorer Api Mcp Server Prompt Argument[] - Parameters for the prompt. See
argumentsbelow. - content string
- Full content of the prompt, supporting dynamic parameters. Parameters must be defined in Arguments, using the format {{ARG}}, where ARG supports English characters. Example: My name is: {{name}}.
- description string
- Description of the prompt parameter.
- name string
- Name of the prompt parameter.
- arguments
Sequence[Open
Api Explorer Api Mcp Server Prompt Argument] - Parameters for the prompt. See
argumentsbelow. - content str
- Full content of the prompt, supporting dynamic parameters. Parameters must be defined in Arguments, using the format {{ARG}}, where ARG supports English characters. Example: My name is: {{name}}.
- description str
- Description of the prompt parameter.
- name str
- Name of the prompt parameter.
- arguments List<Property Map>
- Parameters for the prompt. See
argumentsbelow. - content String
- Full content of the prompt, supporting dynamic parameters. Parameters must be defined in Arguments, using the format {{ARG}}, where ARG supports English characters. Example: My name is: {{name}}.
- description String
- Description of the prompt parameter.
- name String
- Name of the prompt parameter.
OpenApiExplorerApiMcpServerPromptArgument, OpenApiExplorerApiMcpServerPromptArgumentArgs
- Description string
- Description of the API MCP service.
- Name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- Required bool
- Indicates whether the prompt parameter is required.
- Description string
- Description of the API MCP service.
- Name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- Required bool
- Indicates whether the prompt parameter is required.
- description String
- Description of the API MCP service.
- name String
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- required Boolean
- Indicates whether the prompt parameter is required.
- description string
- Description of the API MCP service.
- name string
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- required boolean
- Indicates whether the prompt parameter is required.
- description str
- Description of the API MCP service.
- name str
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- required bool
- Indicates whether the prompt parameter is required.
- description String
- Description of the API MCP service.
- name String
- Name of the MCP Server. It can contain digits, English letters, and hyphens (-).
- required Boolean
- Indicates whether the prompt parameter is required.
OpenApiExplorerApiMcpServerTerraformTool, OpenApiExplorerApiMcpServerTerraformToolArgs
- Async bool
- Specifies whether execution is asynchronous. If enabled, the system immediately proceeds to the next task after initiating a task, without waiting for each resource operation to complete.
- Code string
- Description string
- Destroy
Policy string - The cleanup policy applied to temporary resources after task completion, based on the task execution status:
- NEVER: Do not delete any created resources, regardless of whether the task succeeds or fails.
- ALWAYS: Immediately destroy all related resources upon task completion, regardless of success or failure.
- ON_FAILURE: Delete related resources only if the task fails; retain them if the task succeeds.
- Name string
- Async bool
- Specifies whether execution is asynchronous. If enabled, the system immediately proceeds to the next task after initiating a task, without waiting for each resource operation to complete.
- Code string
- Description string
- Destroy
Policy string - The cleanup policy applied to temporary resources after task completion, based on the task execution status:
- NEVER: Do not delete any created resources, regardless of whether the task succeeds or fails.
- ALWAYS: Immediately destroy all related resources upon task completion, regardless of success or failure.
- ON_FAILURE: Delete related resources only if the task fails; retain them if the task succeeds.
- Name string
- async Boolean
- Specifies whether execution is asynchronous. If enabled, the system immediately proceeds to the next task after initiating a task, without waiting for each resource operation to complete.
- code String
- description String
- destroy
Policy String - The cleanup policy applied to temporary resources after task completion, based on the task execution status:
- NEVER: Do not delete any created resources, regardless of whether the task succeeds or fails.
- ALWAYS: Immediately destroy all related resources upon task completion, regardless of success or failure.
- ON_FAILURE: Delete related resources only if the task fails; retain them if the task succeeds.
- name String
- async boolean
- Specifies whether execution is asynchronous. If enabled, the system immediately proceeds to the next task after initiating a task, without waiting for each resource operation to complete.
- code string
- description string
- destroy
Policy string - The cleanup policy applied to temporary resources after task completion, based on the task execution status:
- NEVER: Do not delete any created resources, regardless of whether the task succeeds or fails.
- ALWAYS: Immediately destroy all related resources upon task completion, regardless of success or failure.
- ON_FAILURE: Delete related resources only if the task fails; retain them if the task succeeds.
- name string
- async_ bool
- Specifies whether execution is asynchronous. If enabled, the system immediately proceeds to the next task after initiating a task, without waiting for each resource operation to complete.
- code str
- description str
- destroy_
policy str - The cleanup policy applied to temporary resources after task completion, based on the task execution status:
- NEVER: Do not delete any created resources, regardless of whether the task succeeds or fails.
- ALWAYS: Immediately destroy all related resources upon task completion, regardless of success or failure.
- ON_FAILURE: Delete related resources only if the task fails; retain them if the task succeeds.
- name str
- async Boolean
- Specifies whether execution is asynchronous. If enabled, the system immediately proceeds to the next task after initiating a task, without waiting for each resource operation to complete.
- code String
- description String
- destroy
Policy String - The cleanup policy applied to temporary resources after task completion, based on the task execution status:
- NEVER: Do not delete any created resources, regardless of whether the task succeeds or fails.
- ALWAYS: Immediately destroy all related resources upon task completion, regardless of success or failure.
- ON_FAILURE: Delete related resources only if the task fails; retain them if the task succeeds.
- name String
Import
Open Api Explorer Api Mcp Server can be imported using the id, e.g.
$ pulumi import alicloud:index/openApiExplorerApiMcpServer:OpenApiExplorerApiMcpServer example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.
