Skip to content

Commit 28c1cc9

Browse files
committed
[docs] add info on studio-mode mcp server
1 parent adc9830 commit 28c1cc9

File tree

3 files changed

+55
-4
lines changed

3 files changed

+55
-4
lines changed

packages/cli/CLAUDE.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ npx @vue-skuilder/cli pack my-course
2424

2525
### Project Initialization
2626
- **init**: Scaffolds new course project structure
27+
- **studio**: Launches complete editing environment with CouchDB, web UI, and MCP server
2728
- **pack**: Packages course content for distribution
29+
- **unpack**: Imports course content from CouchDB to static files
2830

2931
## Dependencies
3032

@@ -49,12 +51,24 @@ npx @vue-skuilder/cli pack my-course
4951
- **Configuration**: Generates initial course configuration
5052
- **Dependencies**: Installs required npm packages
5153

54+
### Studio Command (`commands/studio.ts`)
55+
- **Environment Setup**: Launches CouchDB, Express API, and web interface
56+
- **Data Loading**: Unpacks course data to temporary database
57+
- **MCP Server**: Provides Model Context Protocol server for Claude Code integration
58+
- **Configuration Display**: Shows MCP connection details and .mcp.json content
59+
5260
### Pack Command (`commands/pack.ts`)
5361
- **Course Compilation**: Bundles course content for distribution
5462
- **Static Data**: Converts dynamic course data to static format
5563
- **Optimization**: Minifies and optimizes course assets
5664
- **Packaging**: Creates deployable course bundle
5765

66+
### MCP Server (`mcp-server.ts`)
67+
- **Protocol Implementation**: Full MCP server with 14 resources, 4 tools, 2 prompts
68+
- **Course Access**: Direct CourseDBInterface integration for real-time data
69+
- **Content Generation**: AI-powered card creation and content authoring
70+
- **ELO Integration**: Native support for difficulty rating system
71+
5872
## Utilities
5973

6074
### Template Management (`utils/template.ts`)
@@ -78,7 +92,8 @@ npx @vue-skuilder/cli pack my-course
7892
- **Binary Linking**: Automatically creates `skuilder` command alias
7993

8094
## Use Cases
81-
- **Course Authors**: Initialize new course projects
82-
- **Content Creators**: Package courses for distribution
95+
- **Course Authors**: Initialize new course projects with MCP server support
96+
- **Content Creators**: Package courses for distribution with AI-enabled authoring
8397
- **Developers**: Bootstrap vue-skuilder development environment
98+
- **Claude Code Users**: AI-enabled course content creation and editing via MCP
8499
- **Deployment**: Automated course packaging for CI/CD

packages/cli/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ Studio mode creates a full editing environment by starting multiple services:
9696
- Create/edit cards, manage tags, bulk import
9797
- Live preview of changes
9898

99+
4. **MCP Server** (Course Content Agent)
100+
- Model Context Protocol server for Claude Code integration
101+
- AI-powered course content authoring and editing
102+
- Direct access to course data, cards, tags, and ELO ratings
103+
- Configuration for MCP clients is output at startup
104+
99105
#### Studio Workflow
100106

101107
1. **Load Course Data**: Unpacks your `public/static-courses/` JSON files into temporary CouchDB

packages/cli/src/utils/template.ts

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,9 +590,39 @@ When you run \`npm run studio\`, it will:
590590
1. Start a local CouchDB instance for temporary editing
591591
2. Load your course data from \`public/static-courses/\`
592592
3. Launch the studio interface at http://localhost:7174
593-
4. Save changes back to your static course files when you flush
593+
4. Provide MCP server connection for, eg, Claude Code integration
594+
5. Save changes back to your static course files when you flush
594595
595-
**Important**: Studio mode **overwrites** existing static data source files in \`public/static-courses/\`. Make sure to commit or backup your course data before making major edits.`
596+
**Important**: Studio mode **overwrites** existing static data source files in \`public/static-courses/\`. Make sure to commit or backup your course data before making major edits.
597+
598+
### Claude Code Integration (MCP Server)
599+
600+
Studio mode automatically provides an MCP (Model Context Protocol) server for AI-powered course authoring with Claude Code. When you run \`npm run studio\`, it displays connection details like:
601+
602+
\`\`\`bash
603+
🔗 MCP Server: node ./node_modules/@vue-skuilder/cli/dist/mcp-server.js course-id 5985
604+
📋 .mcp.json content:
605+
{
606+
"mcpServers": {
607+
"vue-skuilder-studio": {
608+
"command": "./node_modules/@vue-skuilder/cli/dist/mcp-server.js",
609+
"args": ["course-id", "5985"],
610+
"env": {
611+
"COUCHDB_SERVER_URL": "localhost:5985",
612+
"COUCHDB_SERVER_PROTOCOL": "http",
613+
"COUCHDB_USERNAME": "admin",
614+
"COUCHDB_PASSWORD": "password"
615+
}
616+
}
617+
}
618+
}
619+
\`\`\`
620+
621+
Copy the generated \`.mcp.json\` content to your Claude Code configuration to enable:
622+
- **AI Content Creation**: Generate course cards with fill-in-the-blank and multiple-choice questions
623+
- **Smart Tagging**: Automatically tag cards and assign ELO difficulty ratings
624+
- **Course Analysis**: Analyze existing course content and suggest improvements
625+
- **Bulk Content Operations**: Create multiple cards at once with consistent formatting`
596626
: ''
597627
}
598628

0 commit comments

Comments
 (0)