Skip to content

Commit e6f5744

Browse files
avrabeavrabe
committed
feat: add working examples and configuration samples
Add comprehensive examples directory with practical usage guides: - Add examples/README.md with usage patterns and quick start guides - Add configuration examples: basic, dev, prod, and multi-instance setups - Add claude-desktop.md with detailed integration instructions - Add pipeline-automation.md with advanced workflow examples Configuration samples include: - basic-config.json: minimal working setup - dev-config.json: development environment with debug settings - prod-config.json: production configuration with security hardening - multi-instance-config.json: multiple Studio instance management The examples provide ready-to-use configurations and detailed integration guides for common deployment scenarios.
1 parent 0730247 commit e6f5744

File tree

7 files changed

+773
-0
lines changed

7 files changed

+773
-0
lines changed

‎examples/README.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Examples
2+
3+
This directory contains working examples and configuration samples for the WindRiver Studio MCP Server.
4+
5+
## Quick Start Examples
6+
7+
### Basic Setup
8+
- [basic-config.json](basic-config.json) - Minimal working configuration
9+
- [claude-desktop.md](claude-desktop.md) - Claude Desktop integration guide
10+
- [first-pipeline.md](first-pipeline.md) - Running your first pipeline query
11+
12+
### Configuration Examples
13+
- [dev-config.json](dev-config.json) - Development environment setup
14+
- [prod-config.json](prod-config.json) - Production configuration with security
15+
- [multi-instance-config.json](multi-instance-config.json) - Multiple Studio instances
16+
17+
### Integration Examples
18+
- [vscode-integration.md](vscode-integration.md) - VS Code MCP extension setup
19+
- [api-usage.py](api-usage.py) - Direct MCP protocol usage
20+
- [monitoring-setup.md](monitoring-setup.md) - Performance monitoring
21+
22+
### Workflow Examples
23+
- [pipeline-automation.md](pipeline-automation.md) - Automated pipeline management
24+
- [status-monitoring.md](status-monitoring.md) - Pipeline status dashboards
25+
- [troubleshooting-workflow.md](troubleshooting-workflow.md) - Debugging pipelines
26+
27+
## Usage Patterns
28+
29+
### Common Queries
30+
31+
Ask Claude to help with these typical Studio operations:
32+
33+
```
34+
"Show me all my active pipelines"
35+
"What's the status of pipeline XYZ-123?"
36+
"List all failed tasks in my recent pipelines"
37+
"Show me the logs for task ABC in pipeline XYZ-123"
38+
"Start the deployment pipeline for project MyApp"
39+
```
40+
41+
### Advanced Workflows
42+
43+
```
44+
"Create a summary of all pipeline failures this week"
45+
"Compare the performance of pipelines between staging and production"
46+
"Help me diagnose why pipeline XYZ-123 is failing repeatedly"
47+
"Set up monitoring for my critical production pipelines"
48+
```
49+
50+
## Testing Your Setup
51+
52+
1. **Configuration Test**:
53+
```bash
54+
npx @pulseengine/studio-mcp-server@latest --check-config basic-config.json
55+
```
56+
57+
2. **Connection Test**:
58+
```bash
59+
npx @pulseengine/studio-mcp-server@latest --test-connection basic-config.json
60+
```
61+
62+
3. **Claude Desktop Test**:
63+
- Use configuration from [claude-desktop.md](claude-desktop.md)
64+
- Ask Claude: "Can you list my Studio pipelines?"
65+
66+
## Getting Help
67+
68+
- Check [troubleshooting guide](../docs/troubleshooting.md) for common issues
69+
- Review [configuration reference](../docs/configuration.md) for all options
70+
- Open [GitHub issues](https://github.com/pulseengine/studio-mcp/issues) for bugs
71+
- Use [GitHub discussions](https://github.com/pulseengine/studio-mcp/discussions) for questions

‎examples/basic-config.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"connections": {
3+
"default": {
4+
"name": "My Studio",
5+
"url": "https://your-studio-instance.com",
6+
"username": "your-username"
7+
}
8+
},
9+
"cli": {
10+
"download_base_url": "https://distro.windriver.com/dist/wrstudio/wrstudio-cli-distro-cd",
11+
"version": "auto",
12+
"auto_update": true
13+
}
14+
}

‎examples/claude-desktop.md‎

Lines changed: 269 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
# Claude Desktop Integration
2+
3+
This guide shows how to integrate the WindRiver Studio MCP Server with Claude Desktop.
4+
5+
## Prerequisites
6+
7+
1. **Claude Desktop**: Download from [claude.ai](https://claude.ai/desktop)
8+
2. **Studio MCP Server**: Install via npm or build from source
9+
3. **Studio Access**: Valid WindRiver Studio credentials
10+
11+
## Configuration Steps
12+
13+
### 1. Create Configuration File
14+
15+
Create a configuration file (e.g., `studio-config.json`):
16+
17+
```json
18+
{
19+
"connections": {
20+
"default": {
21+
"name": "My Studio",
22+
"url": "https://your-studio-instance.com",
23+
"username": "your-username"
24+
}
25+
},
26+
"cli": {
27+
"download_base_url": "https://distro.windriver.com/dist/wrstudio/wrstudio-cli-distro-cd",
28+
"version": "auto",
29+
"auto_update": true
30+
},
31+
"cache": {
32+
"enabled": true,
33+
"max_memory_mb": 50
34+
}
35+
}
36+
```
37+
38+
### 2. Configure Claude Desktop
39+
40+
#### Option A: Using npm package (Recommended)
41+
42+
Add to your Claude Desktop MCP configuration file:
43+
44+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
45+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
46+
47+
```json
48+
{
49+
"mcpServers": {
50+
"windrive-studio": {
51+
"command": "npx",
52+
"args": [
53+
"@pulseengine/studio-mcp-server@latest",
54+
"/path/to/your/studio-config.json"
55+
]
56+
}
57+
}
58+
}
59+
```
60+
61+
#### Option B: Using compiled binary
62+
63+
```json
64+
{
65+
"mcpServers": {
66+
"windrive-studio": {
67+
"command": "/path/to/studio-mcp-server",
68+
"args": ["/path/to/your/studio-config.json"]
69+
}
70+
}
71+
}
72+
```
73+
74+
### 3. Set Credentials
75+
76+
#### Environment Variables (Recommended)
77+
78+
Set your Studio password as an environment variable:
79+
80+
**macOS/Linux**:
81+
```bash
82+
export STUDIO_PASSWORD="your-password"
83+
```
84+
85+
**Windows**:
86+
```cmd
87+
set STUDIO_PASSWORD=your-password
88+
```
89+
90+
#### Keyring Storage
91+
92+
For persistent credential storage, use keyring authentication:
93+
94+
```json
95+
{
96+
"connections": {
97+
"default": {
98+
"name": "My Studio",
99+
"url": "https://your-studio-instance.com",
100+
"username": "your-username",
101+
"auth_method": "keyring"
102+
}
103+
}
104+
}
105+
```
106+
107+
Then set credentials:
108+
```bash
109+
npx @pulseengine/studio-mcp-server@latest --set-password studio-config.json
110+
```
111+
112+
### 4. Restart Claude Desktop
113+
114+
Restart Claude Desktop to load the new MCP server configuration.
115+
116+
## Testing the Integration
117+
118+
### Basic Connection Test
119+
120+
Ask Claude:
121+
```
122+
"Can you check if the Studio MCP server is working?"
123+
```
124+
125+
Claude should respond with server status information.
126+
127+
### Pipeline Queries
128+
129+
Try these example queries:
130+
131+
```
132+
"Show me all my Studio pipelines"
133+
```
134+
135+
```
136+
"What's the status of my recent pipeline runs?"
137+
```
138+
139+
```
140+
"List all active pipelines in my default project"
141+
```
142+
143+
### Resource Exploration
144+
145+
```
146+
"What Studio resources are available through MCP?"
147+
```
148+
149+
```
150+
"Show me the structure of my Studio workspace"
151+
```
152+
153+
## Advanced Configuration
154+
155+
### Multiple Studio Instances
156+
157+
Configure multiple Studio environments:
158+
159+
```json
160+
{
161+
"connections": {
162+
"production": {
163+
"name": "Production Studio",
164+
"url": "https://prod-studio.company.com",
165+
"username": "prod-user"
166+
},
167+
"staging": {
168+
"name": "Staging Studio",
169+
"url": "https://staging-studio.company.com",
170+
"username": "staging-user"
171+
}
172+
}
173+
}
174+
```
175+
176+
### Performance Tuning
177+
178+
For better performance with frequent queries:
179+
180+
```json
181+
{
182+
"cache": {
183+
"enabled": true,
184+
"max_memory_mb": 100,
185+
"ttl": {
186+
"immutable": 7200,
187+
"completed": 172800,
188+
"semi_dynamic": 1200,
189+
"dynamic": 120
190+
}
191+
},
192+
"server": {
193+
"max_concurrent_requests": 5,
194+
"timeout_seconds": 45
195+
}
196+
}
197+
```
198+
199+
## Troubleshooting
200+
201+
### Server Not Connecting
202+
203+
1. **Check configuration**:
204+
```bash
205+
npx @pulseengine/studio-mcp-server@latest --check-config studio-config.json
206+
```
207+
208+
2. **Test Studio connection**:
209+
```bash
210+
npx @pulseengine/studio-mcp-server@latest --test-connection studio-config.json
211+
```
212+
213+
3. **Check Claude Desktop logs**:
214+
- **macOS**: `~/Library/Logs/Claude/mcp.log`
215+
- **Windows**: `%LOCALAPPDATA%\Claude\logs\mcp.log`
216+
217+
### Authentication Issues
218+
219+
1. **Verify credentials**:
220+
```bash
221+
echo $STUDIO_PASSWORD # Should show your password
222+
```
223+
224+
2. **Test manual login**:
225+
```bash
226+
studio-cli login --url https://your-studio-instance.com --username your-username
227+
```
228+
229+
3. **Check keyring storage**:
230+
```bash
231+
npx @pulseengine/studio-mcp-server@latest --check-auth studio-config.json
232+
```
233+
234+
### Performance Issues
235+
236+
1. **Enable caching**:
237+
```json
238+
{
239+
"cache": {
240+
"enabled": true,
241+
"max_memory_mb": 100
242+
}
243+
}
244+
```
245+
246+
2. **Increase timeouts**:
247+
```json
248+
{
249+
"server": {
250+
"timeout_seconds": 60
251+
}
252+
}
253+
```
254+
255+
3. **Monitor performance**:
256+
```json
257+
{
258+
"server": {
259+
"enable_metrics": true
260+
}
261+
}
262+
```
263+
264+
## Next Steps
265+
266+
- Explore [workflow examples](pipeline-automation.md)
267+
- Set up [monitoring and alerts](monitoring-setup.md)
268+
- Review [best practices](../docs/best-practices.md)
269+
- Check out [advanced integrations](vscode-integration.md)

‎examples/dev-config.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"connections": {
3+
"development": {
4+
"name": "Development Studio",
5+
"url": "https://dev-studio.company.com",
6+
"username": "dev-user"
7+
}
8+
},
9+
"cli": {
10+
"download_base_url": "https://distro.windriver.com/dist/wrstudio/wrstudio-cli-distro-cd",
11+
"version": "auto",
12+
"auto_update": true,
13+
"timeout_seconds": 180
14+
},
15+
"cache": {
16+
"enabled": true,
17+
"max_memory_mb": 50,
18+
"ttl": {
19+
"immutable": 300,
20+
"completed": 3600,
21+
"semi_dynamic": 60,
22+
"dynamic": 10
23+
}
24+
},
25+
"server": {
26+
"timeout_seconds": 30,
27+
"max_concurrent_requests": 3,
28+
"enable_metrics": true,
29+
"log_level": "debug",
30+
"sensitive_data_filter": true
31+
}
32+
}

0 commit comments

Comments
 (0)