Skip to content

Commit 638d10c

Browse files
committed
Updates extension framework docs
1 parent b8c974d commit 638d10c

File tree

2 files changed

+115
-1
lines changed

2 files changed

+115
-1
lines changed

cli/azd/.github/copilot-instructions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,19 @@ All Go files must include Microsoft copyright header:
9696
// Licensed under the MIT License.
9797
```
9898

99+
## Extensions Development
100+
101+
### Building Extensions
102+
Extensions are located in `extensions/` directory and use the extension framework:
103+
```bash
104+
# Build and install extension (example using demo extension)
105+
cd extensions/microsoft.azd.demo
106+
azd x build
107+
108+
# Test extension (using extension's namespace from extension.yaml)
109+
azd demo <command>
110+
```
111+
99112
## MCP Tools Development
100113

101114
### Tool Pattern

cli/azd/docs/extension-framework.md

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1114,7 +1114,7 @@ The following are a list of available gRPC services for extension developer to i
11141114

11151115
### Project Service
11161116

1117-
This service manages project configuration retrieval and related operations.
1117+
This service manages project configuration retrieval and related operations, including project and service-level configuration management.
11181118

11191119
> See [project.proto](../grpc/proto/project.proto) for more details.
11201120
@@ -1141,6 +1141,107 @@ Adds a new service to the project.
11411141
- `service`: _ServiceConfig_
11421142
- **Response:** _EmptyResponse_
11431143

1144+
#### GetConfigSection
1145+
1146+
Retrieves a project configuration section by path from AdditionalProperties.
1147+
1148+
- **Request:** _GetProjectConfigSectionRequest_
1149+
- `path` (string): Dot-notation path to the config section
1150+
- **Response:** _GetProjectConfigSectionResponse_
1151+
- Contains:
1152+
- `section` (google.protobuf.Struct): The configuration section
1153+
- `found` (bool): Whether the section exists
1154+
1155+
#### SetConfigSection
1156+
1157+
Sets a project configuration section at the specified path in AdditionalProperties.
1158+
1159+
- **Request:** _SetProjectConfigSectionRequest_
1160+
- `path` (string): Dot-notation path to the config section
1161+
- `section` (google.protobuf.Struct): The configuration section to set
1162+
- **Response:** _EmptyResponse_
1163+
1164+
#### GetConfigValue
1165+
1166+
Retrieves a single project configuration value by path from AdditionalProperties.
1167+
1168+
- **Request:** _GetProjectConfigValueRequest_
1169+
- `path` (string): Dot-notation path to the config value
1170+
- **Response:** _GetProjectConfigValueResponse_
1171+
- Contains:
1172+
- `value` (google.protobuf.Value): The configuration value
1173+
- `found` (bool): Whether the value exists
1174+
1175+
#### SetConfigValue
1176+
1177+
Sets a single project configuration value at the specified path in AdditionalProperties.
1178+
1179+
- **Request:** _SetProjectConfigValueRequest_
1180+
- `path` (string): Dot-notation path to the config value
1181+
- `value` (google.protobuf.Value): The configuration value to set
1182+
- **Response:** _EmptyResponse_
1183+
1184+
#### UnsetConfig
1185+
1186+
Removes a project configuration value or section at the specified path from AdditionalProperties.
1187+
1188+
- **Request:** _UnsetProjectConfigRequest_
1189+
- `path` (string): Dot-notation path to the config to remove
1190+
- **Response:** _EmptyResponse_
1191+
1192+
#### GetServiceConfigSection
1193+
1194+
Retrieves a service configuration section by path from service AdditionalProperties.
1195+
1196+
- **Request:** _GetServiceConfigSectionRequest_
1197+
- `service_name` (string): Name of the service
1198+
- `path` (string): Dot-notation path to the config section
1199+
- **Response:** _GetServiceConfigSectionResponse_
1200+
- Contains:
1201+
- `section` (google.protobuf.Struct): The configuration section
1202+
- `found` (bool): Whether the section exists
1203+
1204+
#### SetServiceConfigSection
1205+
1206+
Sets a service configuration section at the specified path in service AdditionalProperties.
1207+
1208+
- **Request:** _SetServiceConfigSectionRequest_
1209+
- `service_name` (string): Name of the service
1210+
- `path` (string): Dot-notation path to the config section
1211+
- `section` (google.protobuf.Struct): The configuration section to set
1212+
- **Response:** _EmptyResponse_
1213+
1214+
#### GetServiceConfigValue
1215+
1216+
Retrieves a single service configuration value by path from service AdditionalProperties.
1217+
1218+
- **Request:** _GetServiceConfigValueRequest_
1219+
- `service_name` (string): Name of the service
1220+
- `path` (string): Dot-notation path to the config value
1221+
- **Response:** _GetServiceConfigValueResponse_
1222+
- Contains:
1223+
- `value` (google.protobuf.Value): The configuration value
1224+
- `found` (bool): Whether the value exists
1225+
1226+
#### SetServiceConfigValue
1227+
1228+
Sets a single service configuration value at the specified path in service AdditionalProperties.
1229+
1230+
- **Request:** _SetServiceConfigValueRequest_
1231+
- `service_name` (string): Name of the service
1232+
- `path` (string): Dot-notation path to the config value
1233+
- `value` (google.protobuf.Value): The configuration value to set
1234+
- **Response:** _EmptyResponse_
1235+
1236+
#### UnsetServiceConfig
1237+
1238+
Removes a service configuration value or section at the specified path from service AdditionalProperties.
1239+
1240+
- **Request:** _UnsetServiceConfigRequest_
1241+
- `service_name` (string): Name of the service
1242+
- `path` (string): Dot-notation path to the config to remove
1243+
- **Response:** _EmptyResponse_
1244+
11441245
---
11451246

11461247
### Environment Service

0 commit comments

Comments
 (0)