Skip to content

Commit d69f1c4

Browse files
Vishwanath BalajiCopilot
andcommitted
Standardize tool project connection fields
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d0ce100 commit d69f1c4

5 files changed

Lines changed: 48 additions & 56 deletions

File tree

specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14969,7 +14969,7 @@
1496914969
},
1497014970
"project_connection_id": {
1497114971
"type": "string",
14972-
"description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server."
14972+
"description": "The project connection ID used by this tool."
1497314973
}
1497414974
},
1497514975
"allOf": [
@@ -15003,7 +15003,7 @@
1500315003
},
1500415004
"project_connection_id": {
1500515005
"type": "string",
15006-
"description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server."
15006+
"description": "The project connection ID used by this tool."
1500715007
}
1500815008
},
1500915009
"allOf": [
@@ -22594,7 +22594,7 @@
2259422594
},
2259522595
"project_connection_id": {
2259622596
"type": "string",
22597-
"description": "The ID of the FabricIQ project connection."
22597+
"description": "The project connection ID used by this tool."
2259822598
},
2259922599
"server_label": {
2260022600
"type": "string",
@@ -22656,7 +22656,7 @@
2265622656
},
2265722657
"project_connection_id": {
2265822658
"type": "string",
22659-
"description": "The ID of the FabricIQ project connection."
22659+
"description": "The project connection ID used by this tool."
2266022660
},
2266122661
"server_label": {
2266222662
"type": "string",
@@ -24108,7 +24108,7 @@
2410824108
},
2410924109
"project_connection_id": {
2411024110
"type": "string",
24111-
"description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server."
24111+
"description": "The project connection ID used by this tool."
2411224112
}
2411324113
},
2411424114
"allOf": [
@@ -38472,7 +38472,7 @@
3847238472
},
3847338473
"project_connection_id": {
3847438474
"type": "string",
38475-
"description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server."
38475+
"description": "The project connection ID used by this tool."
3847638476
}
3847738477
},
3847838478
"allOf": [
@@ -49688,7 +49688,7 @@
4968849688
},
4968949689
"project_connection_id": {
4969049690
"type": "string",
49691-
"description": "The ID of the WorkIQ project connection."
49691+
"description": "The project connection ID used by this tool."
4969249692
},
4969349693
"name": {
4969449694
"type": "string",
@@ -49722,7 +49722,7 @@
4972249722
},
4972349723
"project_connection_id": {
4972449724
"type": "string",
49725-
"description": "The ID of the WorkIQ project connection."
49725+
"description": "The project connection ID used by this tool."
4972649726
}
4972749727
},
4972849728
"allOf": [

specification/ai-foundry/data-plane/Foundry/openapi3/v1/microsoft-foundry-openapi3.yaml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9966,9 +9966,7 @@ components:
99669966
If not provided, defaults to `/.well-known/agent-card.json`
99679967
project_connection_id:
99689968
type: string
9969-
description: |-
9970-
The connection ID in the project for the A2A server.
9971-
The connection stores authentication and other connection details needed to connect to the A2A server.
9969+
description: The project connection ID used by this tool.
99729970
allOf:
99739971
- $ref: '#/components/schemas/OpenAI.Tool'
99749972
description: An agent implementing the A2A protocol.
@@ -9993,9 +9991,7 @@ components:
99939991
If not provided, defaults to `/.well-known/agent-card.json`
99949992
project_connection_id:
99959993
type: string
9996-
description: |-
9997-
The connection ID in the project for the A2A server.
9998-
The connection stores authentication and other connection details needed to connect to the A2A server.
9994+
description: The project connection ID used by this tool.
99999995
allOf:
100009996
- $ref: '#/components/schemas/ToolboxTool'
100019997
description: An A2A tool stored in a toolbox.
@@ -15345,7 +15341,7 @@ components:
1534515341
description: The object type, which is always 'fabric_iq_preview'.
1534615342
project_connection_id:
1534715343
type: string
15348-
description: The ID of the FabricIQ project connection.
15344+
description: The project connection ID used by this tool.
1534915345
server_label:
1535015346
type: string
1535115347
description: (Optional) The label of the FabricIQ MCP server to connect to.
@@ -15385,7 +15381,7 @@ components:
1538515381
description: The type of the tool. Always `fabric_iq_preview`.
1538615382
project_connection_id:
1538715383
type: string
15388-
description: The ID of the FabricIQ project connection.
15384+
description: The project connection ID used by this tool.
1538915385
server_label:
1539015386
type: string
1539115387
description: (Optional) The label of the FabricIQ MCP server to connect to.
@@ -16343,7 +16339,7 @@ components:
1634316339
default: always
1634416340
project_connection_id:
1634516341
type: string
16346-
description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.
16342+
description: The project connection ID used by this tool.
1634716343
allOf:
1634816344
- $ref: '#/components/schemas/ToolboxTool'
1634916345
description: An MCP tool stored in a toolbox.
@@ -26681,7 +26677,7 @@ components:
2668126677
default: always
2668226678
project_connection_id:
2668326679
type: string
26684-
description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.
26680+
description: The project connection ID used by this tool.
2668526681
allOf:
2668626682
- $ref: '#/components/schemas/OpenAI.Tool'
2668726683
description: |-
@@ -35016,7 +35012,7 @@ components:
3501635012
description: The object type, which is always 'work_iq_preview'.
3501735013
project_connection_id:
3501835014
type: string
35019-
description: The ID of the WorkIQ project connection.
35015+
description: The project connection ID used by this tool.
3502035016
name:
3502135017
type: string
3502235018
description: Optional user-defined name for this tool or configuration.
@@ -35039,7 +35035,7 @@ components:
3503935035
description: The type of the tool. Always `work_iq_preview`.
3504035036
project_connection_id:
3504135037
type: string
35042-
description: The ID of the WorkIQ project connection.
35038+
description: The project connection ID used by this tool.
3504335039
allOf:
3504435040
- $ref: '#/components/schemas/ToolboxTool'
3504535041
description: A WorkIQ tool stored in a toolbox.

specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17546,7 +17546,7 @@
1754617546
},
1754717547
"project_connection_id": {
1754817548
"type": "string",
17549-
"description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server."
17549+
"description": "The project connection ID used by this tool."
1755017550
}
1755117551
},
1755217552
"allOf": [
@@ -17580,7 +17580,7 @@
1758017580
},
1758117581
"project_connection_id": {
1758217582
"type": "string",
17583-
"description": "The connection ID in the project for the A2A server.\nThe connection stores authentication and other connection details needed to connect to the A2A server."
17583+
"description": "The project connection ID used by this tool."
1758417584
}
1758517585
},
1758617586
"allOf": [
@@ -26690,7 +26690,7 @@
2669026690
},
2669126691
"project_connection_id": {
2669226692
"type": "string",
26693-
"description": "The ID of the FabricIQ project connection."
26693+
"description": "The project connection ID used by this tool."
2669426694
},
2669526695
"server_label": {
2669626696
"type": "string",
@@ -26752,7 +26752,7 @@
2675226752
},
2675326753
"project_connection_id": {
2675426754
"type": "string",
26755-
"description": "The ID of the FabricIQ project connection."
26755+
"description": "The project connection ID used by this tool."
2675626756
},
2675726757
"server_label": {
2675826758
"type": "string",
@@ -28277,7 +28277,7 @@
2827728277
},
2827828278
"project_connection_id": {
2827928279
"type": "string",
28280-
"description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server."
28280+
"description": "The project connection ID used by this tool."
2828128281
}
2828228282
},
2828328283
"allOf": [
@@ -42741,7 +42741,7 @@
4274142741
},
4274242742
"project_connection_id": {
4274342743
"type": "string",
42744-
"description": "The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server."
42744+
"description": "The project connection ID used by this tool."
4274542745
}
4274642746
},
4274742747
"allOf": [
@@ -54181,7 +54181,7 @@
5418154181
},
5418254182
"project_connection_id": {
5418354183
"type": "string",
54184-
"description": "The ID of the WorkIQ project connection."
54184+
"description": "The project connection ID used by this tool."
5418554185
},
5418654186
"name": {
5418754187
"type": "string",
@@ -54215,7 +54215,7 @@
5421554215
},
5421654216
"project_connection_id": {
5421754217
"type": "string",
54218-
"description": "The ID of the WorkIQ project connection."
54218+
"description": "The project connection ID used by this tool."
5421954219
}
5422054220
},
5422154221
"allOf": [

specification/ai-foundry/data-plane/Foundry/openapi3/virtual-public-preview/microsoft-foundry-openapi3.yaml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11700,9 +11700,7 @@ components:
1170011700
If not provided, defaults to `/.well-known/agent-card.json`
1170111701
project_connection_id:
1170211702
type: string
11703-
description: |-
11704-
The connection ID in the project for the A2A server.
11705-
The connection stores authentication and other connection details needed to connect to the A2A server.
11703+
description: The project connection ID used by this tool.
1170611704
allOf:
1170711705
- $ref: '#/components/schemas/OpenAI.Tool'
1170811706
description: An agent implementing the A2A protocol.
@@ -11727,9 +11725,7 @@ components:
1172711725
If not provided, defaults to `/.well-known/agent-card.json`
1172811726
project_connection_id:
1172911727
type: string
11730-
description: |-
11731-
The connection ID in the project for the A2A server.
11732-
The connection stores authentication and other connection details needed to connect to the A2A server.
11728+
description: The project connection ID used by this tool.
1173311729
allOf:
1173411730
- $ref: '#/components/schemas/ToolboxTool'
1173511731
description: An A2A tool stored in a toolbox.
@@ -18132,7 +18128,7 @@ components:
1813218128
description: The object type, which is always 'fabric_iq_preview'.
1813318129
project_connection_id:
1813418130
type: string
18135-
description: The ID of the FabricIQ project connection.
18131+
description: The project connection ID used by this tool.
1813618132
server_label:
1813718133
type: string
1813818134
description: (Optional) The label of the FabricIQ MCP server to connect to.
@@ -18172,7 +18168,7 @@ components:
1817218168
description: The type of the tool. Always `fabric_iq_preview`.
1817318169
project_connection_id:
1817418170
type: string
18175-
description: The ID of the FabricIQ project connection.
18171+
description: The project connection ID used by this tool.
1817618172
server_label:
1817718173
type: string
1817818174
description: (Optional) The label of the FabricIQ MCP server to connect to.
@@ -19176,7 +19172,7 @@ components:
1917619172
default: always
1917719173
project_connection_id:
1917819174
type: string
19179-
description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.
19175+
description: The project connection ID used by this tool.
1918019176
allOf:
1918119177
- $ref: '#/components/schemas/ToolboxTool'
1918219178
description: An MCP tool stored in a toolbox.
@@ -29584,7 +29580,7 @@ components:
2958429580
default: always
2958529581
project_connection_id:
2958629582
type: string
29587-
description: The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.
29583+
description: The project connection ID used by this tool.
2958829584
allOf:
2958929585
- $ref: '#/components/schemas/OpenAI.Tool'
2959029586
description: |-
@@ -38072,7 +38068,7 @@ components:
3807238068
description: The object type, which is always 'work_iq_preview'.
3807338069
project_connection_id:
3807438070
type: string
38075-
description: The ID of the WorkIQ project connection.
38071+
description: The project connection ID used by this tool.
3807638072
name:
3807738073
type: string
3807838074
description: Optional user-defined name for this tool or configuration.
@@ -38095,7 +38091,7 @@ components:
3809538091
description: The type of the tool. Always `work_iq_preview`.
3809638092
project_connection_id:
3809738093
type: string
38098-
description: The ID of the WorkIQ project connection.
38094+
description: The project connection ID used by this tool.
3809938095
allOf:
3810038096
- $ref: '#/components/schemas/ToolboxTool'
3810138097
description: A WorkIQ tool stored in a toolbox.

specification/ai-foundry/data-plane/Foundry/src/tools/models.tsp

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ namespace Azure.AI.Projects {
4646
#suppress "@azure-tools/typespec-azure-core/experimental-feature" "Using experimental feature"
4747
@@copyProperties(OpenAI.MCPTool,
4848
{
49-
...ToolProjectConnectionIdExtension,
49+
...OptionalToolProjectConnectionIdField,
5050
}
5151
);
5252

@@ -131,13 +131,23 @@ namespace Azure.AI.Projects {
131131
/**
132132
* Optional project connection ID for tools that can use project-scoped connections.
133133
*/
134-
alias ToolProjectConnectionIdExtension = {
134+
alias OptionalToolProjectConnectionIdField = {
135135
/**
136-
* The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.
136+
* The project connection ID used by this tool.
137137
*/
138138
project_connection_id?: string;
139139
};
140140

141+
/**
142+
* Required project connection ID for tools that use project-scoped connections.
143+
*/
144+
alias RequiredToolProjectConnectionIdField = {
145+
/**
146+
* The project connection ID used by this tool.
147+
*/
148+
project_connection_id: string;
149+
};
150+
141151
/**
142152
* The input definition information for a bing grounding search tool as used to configure an agent.
143153
*/
@@ -771,11 +781,7 @@ namespace Azure.AI.Projects {
771781
*/
772782
agent_card_path?: string;
773783

774-
/**
775-
* The connection ID in the project for the A2A server.
776-
* The connection stores authentication and other connection details needed to connect to the A2A server.
777-
*/
778-
project_connection_id?: string;
784+
...OptionalToolProjectConnectionIdField;
779785
}
780786

781787
/**
@@ -795,10 +801,7 @@ namespace Azure.AI.Projects {
795801
* Shared fields for WorkIQ tool definitions.
796802
*/
797803
model WorkIQPreviewToolFields {
798-
/**
799-
* The ID of the WorkIQ project connection.
800-
*/
801-
project_connection_id: string;
804+
...RequiredToolProjectConnectionIdField;
802805
}
803806

804807
/**
@@ -818,10 +821,7 @@ namespace Azure.AI.Projects {
818821
* Shared fields for FabricIQ tool definitions.
819822
*/
820823
model FabricIQPreviewToolFields {
821-
/**
822-
* The ID of the FabricIQ project connection.
823-
*/
824-
project_connection_id: string;
824+
...RequiredToolProjectConnectionIdField;
825825

826826
/**
827827
* (Optional) The label of the FabricIQ MCP server to connect to.

0 commit comments

Comments
 (0)