Skip to content

Commit 804763b

Browse files
authored
docs: add technical diagrams and improve documentation (#10)
precision
1 parent 75b7fd9 commit 804763b

File tree

16 files changed

+593
-314
lines changed

16 files changed

+593
-314
lines changed

CLAUDE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,22 @@ cmd/mcp-front/ # Main application entry point
165165
7. **Ask questions when uncertain** - Don't assume and proceed
166166
8. **No hacks or shortcuts** - Only clean, maintainable solutions
167167

168+
### Documentation Standards
169+
170+
**Write precise, technical language:**
171+
- ❌ "When Claude connects to MCP Front, it includes a bearer token in the Authorization header"
172+
- ✅ "An MCP client can connect to MCP Front with a bearer token"
173+
- ❌ "Users log in with their Google account"
174+
- ✅ "Claude redirects users to Google for authentication"
175+
- ❌ "Claude establishes SSE connection"
176+
- ✅ "Claude connects via SSE"
177+
178+
**Key clarifications:**
179+
- **Claude.ai only supports OAuth** - Bearer tokens are for development/alternative clients only
180+
- **Avoid redundant implementation details** - "bearer token" implies Authorization header
181+
- **Use precise actors** - "MCP client" not "user" in technical contexts
182+
- **Be specific about auth flow** - Claude handles the OAuth redirect, MCP Front validates domains
183+
168184
### Refactoring Guidelines
169185

170186
When refactoring for better design:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# mcp-front
1+
# mcp-front <img src="docs-site/src/assets/logo.svg" alt="MCP Front" width="32" height="32" style="vertical-align: middle;">
22

33
![Docker image with tag latest](https://img.shields.io/docker/image-size/dgellow/mcp-front/latest?style=flat&logo=docker&label=latest)
44
![Docker image with tag docker-client-latest](https://img.shields.io/docker/image-size/dgellow/mcp-front/docker-client-latest?style=flat&logo=docker&label=docker-client-latest)

docs-site/astro.config.mjs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@ export default defineConfig({
2222
{ label: 'Introduction', slug: 'index' },
2323
{ label: 'Quickstart', slug: 'quickstart' },
2424
{
25-
label: 'Examples',
25+
label: 'Guides',
2626
items: [
27-
{ label: 'Bearer Token', slug: 'examples/bearer-token' },
2827
{ label: 'OAuth with Google', slug: 'examples/oauth-google' },
29-
{ label: 'Deploy to Cloud Run', slug: 'examples/cloud-run' },
28+
{ label: 'Bearer Token', slug: 'examples/bearer-token' },
3029
],
3130
},
3231
{ label: 'Configuration', slug: 'configuration' },
Lines changed: 85 additions & 0 deletions
Loading

docs-site/public/oauth-flow.svg

Lines changed: 122 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)