Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 168 additions & 0 deletions CLAUDE_DESKTOP_SETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Quick Start: Connect Claude Desktop to guided.dev

Get AI-powered secure coding guidance in your Claude Desktop conversations.

## Prerequisites

- ✅ Claude Desktop installed ([download](https://claude.ai/download))
- ✅ Node.js installed ([download](https://nodejs.org))
- ✅ guided.dev server running

## 1. Start the guided.dev Server

```bash
cd /path/to/guided
mix phx.server
```

Verify it's running:
```bash
curl http://localhost:4000/mcp
```

## 2. Configure Claude Desktop

**Find your config file:**
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux**: `~/.config/Claude/claude_desktop_config.json`

**Add guided.dev to the config:**

```json
{
"mcpServers": {
"guided-dev": {
"command": "npx",
"args": [
"mcp-remote",
"http://localhost:4000/mcp"
]
}
}
}
```

**If you have other MCP servers, just add guided.dev to the list:**

```json
{
"mcpServers": {
"guided-dev": {
"command": "npx",
"args": [
"mcp-remote",
"http://localhost:4000/mcp"
]
},
"your-other-server": {
"command": "...",
"args": ["..."]
}
}
}
```

## 3. Restart Claude Desktop

Close and reopen Claude Desktop completely.

## 4. Test It!

In a new Claude conversation:

```
You: Do you have access to guided.dev?
```

Claude should confirm it has access to three tools:
- `tech_stack_recommendation`
- `secure_coding_pattern`
- `deployment_guidance`

## Example Usage

### Get Tech Stack Recommendations

```
You: I want to build a dashboard to track my team's metrics
```

Claude will use `tech_stack_recommendation` and provide secure recommendations with security advisories.

### Get Secure Coding Patterns

```
You: How do I safely query a SQLite database in Python?
```

Claude will use `secure_coding_pattern` and show you secure code examples.

### Get Deployment Guidance

```
You: Where should I deploy my Streamlit app?
```

Claude will use `deployment_guidance` and recommend deployment platforms.

## Troubleshooting

### "I don't have access to guided.dev"

1. **Check server is running:**
```bash
curl http://localhost:4000/mcp
```

2. **Verify npx is available:**
```bash
npx --version
```

3. **Check Claude Desktop logs:**
- macOS: `~/Library/Logs/Claude/`
- Windows: `%APPDATA%\Claude\logs\`
- Linux: `~/.config/Claude/logs/`

4. **Restart both:**
- Stop and restart guided.dev server
- Completely quit and reopen Claude Desktop

### "Connection refused"

Make sure Phoenix is running on port 4000:
```bash
lsof -i :4000
```

Should show something like:
```
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
beam.smp 1234 user 45u IPv4 0x... 0t0 TCP *:4000 (LISTEN)
```

### "npx: command not found"

Install Node.js from [nodejs.org](https://nodejs.org), then try again.

## What You Get

When Claude uses guided.dev, it provides:

✅ **Security-First Recommendations** - All tech stacks come with OWASP Top 10 security advisories
✅ **Secure Code Examples** - Real code snippets using best practices
✅ **Deployment Guidance** - Recommendations based on your stack and requirements
✅ **Up-to-Date Knowledge** - Curated from the guided.dev knowledge graph

## Need More Help?

- **Full Documentation**: [docs/MCP_SERVER.md](guided/docs/MCP_SERVER.md)
- **AGENTS.md Protocol**: [AGENTS.md](AGENTS.md)
- **GitHub Issues**: [github.com/carverauto/guided/issues](https://github.com/carverauto/guided/issues)

---

**Ready to build secure software with AI?** 🚀

Start a conversation with Claude and ask for development guidance!
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,34 @@ Visit [`localhost:4000`](http://localhost:4000) from your browser.

For detailed setup instructions and manual installation, see [**docs/DEVELOPMENT.md**](guided/docs/DEVELOPMENT.md).

## Using with Claude Desktop

Connect Claude Desktop to guided.dev to get AI-powered secure coding guidance in your conversations!

**Quick Setup:**

1. Start the server: `mix phx.server`
2. Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"guided-dev": {
"command": "npx",
"args": ["mcp-remote", "http://localhost:4000/mcp"]
}
}
}
```
3. Restart Claude Desktop
4. Ask Claude: "Do you have access to guided.dev?"

**What you get:**
- 🔒 **Security-first recommendations** with OWASP Top 10 advisories
- 💻 **Secure code patterns** with real examples
- 🚀 **Deployment guidance** for your tech stack

**📖 Full guide:** [CLAUDE_DESKTOP_SETUP.md](CLAUDE_DESKTOP_SETUP.md)

## Project Vision

### The Problem
Expand Down Expand Up @@ -191,6 +219,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.

## Documentation

- [**Claude Desktop Setup**](CLAUDE_DESKTOP_SETUP.md) - Quick start guide for Claude Desktop integration ⭐
- [Development Setup](guided/docs/DEVELOPMENT.md) - Complete setup guide
- [MCP Server Guide](guided/docs/MCP_SERVER.md) - MCP server documentation and API reference
- [AGENTS.md Specification](AGENTS.md) - The protocol spec for AI agents
Expand Down
Loading
Loading