Skip to content

Commit 3e5b5db

Browse files
committed
Updates extension framework docs
1 parent 0022f85 commit 3e5b5db

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
@@ -1130,7 +1130,7 @@ The following are a list of available gRPC services for extension developer to i
11301130

11311131
### Project Service
11321132

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

11351135
> See [project.proto](../grpc/proto/project.proto) for more details.
11361136
@@ -1157,6 +1157,107 @@ Adds a new service to the project.
11571157
- `service`: _ServiceConfig_
11581158
- **Response:** _EmptyResponse_
11591159

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

11621263
### Environment Service

0 commit comments

Comments
 (0)