Skip to content

Commit fb2ae9d

Browse files
committed
Remove redundant VSCode setup sections, keep only Global VSCode Settings
Cleaned up documentation by removing: - Individual file schema reference instructions - Benefits sections that were duplicated - Step-by-step VSCode setup instructions Kept only: - Global VSCode Settings with settings.json configuration - Streamlined IDE integration instructions This simplifies the documentation while maintaining the essential VSCode integration guidance through the global settings approach, which is more practical for users working with multiple configuration files.
1 parent b8d43d7 commit fb2ae9d

File tree

7 files changed

+40
-117
lines changed

7 files changed

+40
-117
lines changed

docs/experimental/README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,6 @@ agent = loader.load_agent(config)
5353

5454
### IDE Integration Setup
5555

56-
**VSCode Setup:**
57-
1. Install the "YAML" extension by Red Hat
58-
2. Add schema reference to your configuration files:
59-
```yaml
60-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
61-
62-
agent:
63-
model: "us.amazon.nova-pro-v1:0"
64-
# Enjoy autocompletion and validation!
65-
```
66-
6756
**Global VSCode Settings:**
6857
```json
6958
{

docs/experimental/config-loader/agent-config.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,16 @@ The ConfigLoader includes comprehensive schema validation for agents:
6666
- **Type Safety**: Enforced structure and types
6767
- **Documentation**: Schema serves as living documentation
6868

69-
### VSCode Setup
70-
Add this to your configuration files:
71-
```yaml
72-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
73-
74-
agent:
75-
model: "us.anthropic.claude-3-7-sonnet-20250219-v1:0"
76-
system_prompt: "You are a helpful assistant."
77-
# VSCode will provide autocompletion and validation
69+
### Global VSCode Settings
70+
Add to your `settings.json`:
71+
```json
72+
{
73+
"yaml.schemas": {
74+
"https://strandsagents.com/schemas/config/v1": "*.strands.yml"
75+
}
76+
}
7877
```
7978

80-
### Benefits
81-
- Real-time validation in your editor
82-
- Autocompletion for configuration properties
83-
- Clear error messages for invalid configurations
84-
- Consistent structure across all configuration types
85-
8679
## Configuration Schema
8780

8881
### Basic Configuration

docs/experimental/config-loader/graph-config.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -101,24 +101,16 @@ The ConfigLoader includes comprehensive schema validation for graphs:
101101
- **Type Safety**: Enforced structure and types
102102
- **Documentation**: Schema serves as living documentation
103103

104-
### VSCode Setup
105-
Add this to your configuration files:
106-
```yaml
107-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
108-
109-
graph:
110-
nodes:
111-
- node_id: "classifier"
112-
type: "agent"
113-
# VSCode will provide autocompletion and validation
104+
### Global VSCode Settings
105+
Add to your `settings.json`:
106+
```json
107+
{
108+
"yaml.schemas": {
109+
"https://strandsagents.com/schemas/config/v1": "*.strands.yml"
110+
}
111+
}
114112
```
115113

116-
### Benefits
117-
- Real-time validation in your editor
118-
- Autocompletion for configuration properties
119-
- Clear error messages for invalid configurations
120-
- Consistent structure across all configuration types
121-
122114
## Configuration Schema
123115

124116
### Basic Graph Structure

docs/experimental/config-loader/overview.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -55,32 +55,8 @@ The ConfigLoader includes comprehensive schema validation:
5555
- **Type Safety**: Enforced structure and types
5656
- **Documentation**: Schema serves as living documentation
5757

58-
### VSCode Setup
59-
Add this to your configuration files:
60-
```yaml
61-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
62-
63-
agent:
64-
model: "us.anthropic.claude-3-7-sonnet-20250219-v1:0"
65-
# VSCode will provide autocompletion and validation
66-
```
67-
68-
### Benefits
69-
- Real-time validation in your editor
70-
- Autocompletion for configuration properties
71-
- Clear error messages for invalid configurations
72-
- Consistent structure across all configuration types
73-
7458
## IDE Integration
7559

76-
### VSCode Setup
77-
1. Install the "YAML" extension by Red Hat
78-
2. Add schema reference to your configuration files:
79-
```yaml
80-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
81-
```
82-
3. Enjoy autocompletion and validation!
83-
8460
### Global VSCode Settings
8561
Add to your `settings.json`:
8662
```json

docs/experimental/config-loader/structured-output.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,16 @@ The ConfigLoader includes comprehensive schema validation for structured output:
2323
- **Type Safety**: Enforced structure and types
2424
- **Documentation**: Schema serves as living documentation
2525

26-
### VSCode Setup
27-
Add this to your configuration files:
28-
```yaml
29-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
30-
31-
schemas:
32-
- name: "UserProfile"
33-
schema:
34-
type: "object"
35-
# VSCode will provide autocompletion and validation
36-
37-
agent:
38-
model: "us.amazon.nova-pro-v1:0"
39-
structured_output: "UserProfile"
26+
### Global VSCode Settings
27+
Add to your `settings.json`:
28+
```json
29+
{
30+
"yaml.schemas": {
31+
"https://strandsagents.com/schemas/config/v1": "*.strands.yml"
32+
}
33+
}
4034
```
4135

42-
### Benefits
43-
- Real-time validation in your editor
44-
- Autocompletion for configuration properties
45-
- Clear error messages for invalid configurations
46-
- Consistent structure across all configuration types
47-
4836
## Quick Start
4937

5038
### Basic Configuration

docs/experimental/config-loader/swarm-config.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -99,24 +99,16 @@ The ConfigLoader includes comprehensive schema validation for swarms:
9999
- **Type Safety**: Enforced structure and types
100100
- **Documentation**: Schema serves as living documentation
101101

102-
### VSCode Setup
103-
Add this to your configuration files:
104-
```yaml
105-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
106-
107-
swarm:
108-
max_handoffs: 20
109-
agents:
110-
- name: "research_agent"
111-
# VSCode will provide autocompletion and validation
102+
### Global VSCode Settings
103+
Add to your `settings.json`:
104+
```json
105+
{
106+
"yaml.schemas": {
107+
"https://strandsagents.com/schemas/config/v1": "*.strands.yml"
108+
}
109+
}
112110
```
113111

114-
### Benefits
115-
- Real-time validation in your editor
116-
- Autocompletion for configuration properties
117-
- Clear error messages for invalid configurations
118-
- Consistent structure across all configuration types
119-
120112
## Configuration Schema
121113

122114
### Basic Structure

docs/experimental/config-loader/tool-config.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,16 @@ The ConfigLoader includes comprehensive schema validation for tools:
2525
- **Type Safety**: Enforced structure and types
2626
- **Documentation**: Schema serves as living documentation
2727

28-
### VSCode Setup
29-
Add this to your configuration files:
30-
```yaml
31-
# yaml-language-server: $schema=https://strandsagents.com/schemas/config/v1
32-
33-
tools:
34-
- name: "calculator"
35-
- name: "research_assistant"
36-
# VSCode will provide autocompletion and validation
28+
### Global VSCode Settings
29+
Add to your `settings.json`:
30+
```json
31+
{
32+
"yaml.schemas": {
33+
"https://strandsagents.com/schemas/config/v1": "*.strands.yml"
34+
}
35+
}
3736
```
3837

39-
### Benefits
40-
- Real-time validation in your editor
41-
- Autocompletion for configuration properties
42-
- Clear error messages for invalid configurations
43-
- Consistent structure across all configuration types
44-
4538
## Agent-as-Tool Configuration
4639

4740
The most powerful feature is the ability to define specialized agents as tools that can be used by other agents. This enables hierarchical agent architectures and specialized sub-agents.

0 commit comments

Comments
 (0)