什么是 CleanSlice?
提供 NestJS + Nuxt 全栈应用的架构文档与设计模式参考,便于统一工程实践。
README
CleanSlice MCP Server
MCP (Model Context Protocol) server that gives AI coding agents access to the CleanSlice architecture documentation. Connect it to Claude, Cursor, Windsurf, or any MCP-compatible client so the AI knows how to build apps using CleanSlice conventions.
Installation
<details> <summary><b>Install in Claude Code</b></summary>Run this command. See Claude Code MCP docs for more info.
claude mcp add --scope user --transport http cleanslice https://mcp.cleanslice.org/mcp
Remove
--scope userto install for the current project only.
Tip: enforce MCP usage with CLAUDE.md
To make sure Claude Code always consults the CleanSlice MCP before writing any code, add the following to your project's CLAUDE.md:
## CleanSlice MCP — Required
Before writing or modifying any code you MUST consult the CleanSlice MCP:
1. Call `get-started` to load the core architecture rules.
2. Call `list-categories` to see available documentation areas.
3. Call `search` with at least 2 task-relevant queries covering:
(a) core implementation details for the feature you are building,
(b) edge cases, constraints, or standards that apply.
4. Call `read-doc` to read the full document when search snippets aren't enough.
Do NOT guess conventions — always verify against MCP results first.
This ensures the agent reads CleanSlice docs at the start of every task, not after the fact.
Optional: add a Stop hook as a safety net
To catch cases where the agent skips the MCP despite the CLAUDE.md instruction, add this to .claude/settings.json:
{
"hooks": {
"Stop": [
{
"hooks": [
{
"type": "agent",
"timeout": 180,
"prompt": "You are a verification subagent. Your job: ensure the main Claude Code agent used the `cleanslice` MCP knowledge sufficiently and did not guess.\n\nContext JSON:\n$ARGUMENTS\n\nVerification requirements:\n1) Identify what the user asked for (deliverables + constraints) from the conversation/transcript in $ARGUMENTS.\n2) Verify the agent consulted the `cleanslice` MCP server for relevant knowledge BEFORE finalizing:\n - Must call `cleanslice` \"get-started\" at least once (or equivalent) to confirm the server's purpose and usage.\n - Must call \"list-categories\" to understand the available knowledge areas.\n - Must call \"search\" with task-relevant queries (at least 2 searches) covering: (a) core implementation details, (b) edge cases / constraints.\n - May call \"read-doc\" to get full document content when search snippets are insufficient.\n3) Validate coverage:\n - If any required category is relevant but not checked, fail.\n - If answers include specifics that are not supported by MCP results, fail.\n4) Output STRICT JSON only:\n - If everything is verified: {\"ok\": true}\n - If anything is missing/unsupported: {\"ok\": false, \"reason\": \"What is missing + exact MCP calls the main agent must run next (e.g., run list-categories, then search for X/Y, then update the solution).\"}\n\nImportant:\n- `cleanslice` tools will appear as MCP tools. Use whatever exact tool names are available in this environment (they follow the mcp__<server>__<tool> naming pattern).\n- Do not allow stopping until MCP-backed evidence is sufficient."
}
]
}
]
}
}
Go to: Settings -> Cursor Settings -> MCP -> Add new global MCP server
Paste the following into your Cursor ~/.cursor/mcp.json file. You may also install in a specific project by creating .cursor/mcp.json in your project folder. See Cursor MCP docs for more info.
{
"mcpServers": {
"cleanslice": {
"type": "http",
"url": "https://mcp.cleanslice.org/mcp"
}
}
}
Tip: enforce MCP usage with a Cursor rule
Create .cursor/rules/cleanslice.mdc in your project to make Cursor always consult the MCP before writing code:
---
description: CleanSlice architecture rules
globs: **/*.{ts,vue,prisma}
alwaysApply: true
---
## CleanSlice MCP — Required
Before writing or modifying any code you MUST consult the CleanSlice MCP:
1. Call `get-started` to load the core architecture rules.
2. Call `list-categories` to see available documentation areas.
3. Call `search` with at least 2 task-relevant queries covering:
(a) core implementation details for the feature you are building,
(b) edge cases, constraints, or standards that apply.
4. Call `read-doc` to read the full document when search snippets aren't enough.
Do NOT guess conventions — always verify against MCP results first.
Add to your Windsurf MCP config file. See Windsurf MCP docs for more info.
{
"mcpServers": {
"cleanslice": {
"type": "http",
"serverUrl": "https://mcp.cleanslice.org/mcp"
}
}
}
Tip: enforce MCP usage with a Windsurf rule
Create .windsurf/rules/cleanslice.md in your project to make Windsurf always consult the MCP before writing code:
## CleanSlice MCP — Required
Before writing or modifying any code you MUST consult the CleanSlice MCP:
1. Call `get-started` to load the core architecture rules.
2. Call `list-categories` to see available documentation areas.
3. Call `search` with at least 2 task-relevant queries covering:
(a) core implementation details for the feature you are building,
(b) edge cases, constraints, or standards that apply.
4. Call `read-doc` to read the full document when search snippets aren't enough.
Do NOT guess conventions — always verify against MCP results first.
Add to .vscode/mcp.json in your project. See VS Code MCP docs for more info.
{
"servers": {
"cleanslice": {
"type": "http",
"url": "https://mcp.cleanslice.org/mcp"
}
}
}
Tip: enforce MCP usage with Copilot instructions
Create .github/copilot-instructions.md in your project root to make Copilot always consult the MCP before writing code:
## CleanSlice MCP — Required
Before writing or modifying any code you MUST consult the CleanSlice MCP:
1. Call `get-started` to load the core architecture rules.
2. Call `list-categories` to see available documentation areas.
3. Call `search` with at least 2 task-relevant queries covering:
(a) core implementation details for the feature you are building,
(b) edge cases, constraints, or standards that apply.
4. Call `read-doc` to read the full document when search snippets aren't enough.
Do NOT guess conventions — always verify against MCP results first.
Add to your claude_desktop_config.json. See Claude Desktop MCP docs for more info.
{
"mcpServers": {
"cleanslice": {
"type": "http",
"url": "https://mcp.cleanslice.org/mcp"
}
}
}
Add this to your Opencode configuration file. See Opencode MCP docs for more info.
{
"mcp": {
"cleanslice": {
"type": "remote",
"url": "https://mcp.cleanslice.org/mcp",
"enabled": true
}
}
}
Tip: enforce MCP usage with AGENTS.md
Create AGENTS.md in your project root to make Opencode always consult the MCP before writing code:
## CleanSlice MCP — Required
Before writing or modifying any code you MUST consult the CleanSlice MCP:
1. Call `get-started` to load the core architecture rules.
2. Call `list-categories` to see available documentation areas.
3. Call `search` with at least 2 task-relevant queries covering:
(a) core implementation details for the feature you are building,
(b) edge cases, constraints, or standards that apply.
4. Call `read-doc` to read the full document when search snippets aren't enough.
Do NOT guess conventions — always verify against MCP results first.
git clone https://github.com/CleanSlice/mcp.git
cd mcp
npm install
npm run dev
Then point your MCP client to http://localhost:8080/mcp.
Available Tools
| Tool | Description |
|---|---|
get-started | Returns the essential CleanSlice rules and conventions. Call this first. |
list-categories | Lists all documentation categories available for search filtering |
search | Search docs by query, category, framework, phase, or tags. Returns snippets (keyword-in-context excerpts) and document paths |
read-doc | Read the full content of a specific document by path. Use after search to get complete docs |
Recommended workflow
get-started → learn the core rules
list-categories → discover what's available
search(query: "...") → find relevant docs (returns snippets)
read-doc(path: "...") → read full document when snippets aren't enough
The search tool returns 1-3 keyword-in-context snippets per result instead of full document content. This keeps responses compact (~3-5K instead of ~95K) while showing the most relevant sections. Use read-doc with the path from search results to fetch the complete document when needed.
Environment Variables
| Variable | Default | Description |
|---|---|---|
PORT | 8080 | Server port |
NODE_ENV | - | Set to dev for debug/verbose logging |
DOCS_PATH | Auto-discover | Path to bundled docs directory |
GITHUB_REPO | CleanSlice/docs | Fallback GitHub repo for docs |
GITHUB_BRANCH | main | GitHub branch to fetch from |
GITHUB_TOKEN | - | GitHub token (optional, for higher rate limits) |
GITHUB_CACHE_TTL | 3600 | GitHub content cache TTL in seconds |
CORS_ORIGIN | * | Allowed CORS origin(s) |
Docker
docker build -t cleanslice-mcp .
docker run -p 8080:8080 cleanslice-mcp
Endpoints
| Endpoint | Description |
|---|---|
GET /sse | SSE transport (for Claude Desktop, Cursor) |
POST /messages | SSE message handler |
POST /mcp | Streamable HTTP transport |
GET /health | Health check |
GET /api | Swagger docs |
常见问题
CleanSlice 是什么?
提供 NestJS + Nuxt 全栈应用的架构文档与设计模式参考,便于统一工程实践。
相关 Skills
前端设计
by anthropics
面向组件、页面、海报和 Web 应用开发,按鲜明视觉方向生成可直接落地的前端代码与高质感 UI,适合做 landing page、Dashboard 或美化现有界面,避开千篇一律的 AI 审美。
✎ 想把页面做得既能上线又有设计感,就用前端设计:组件到整站都能产出,难得的是能避开千篇一律的 AI 味。
网页构建器
by anthropics
面向复杂 claude.ai HTML artifact 开发,快速初始化 React + Tailwind CSS + shadcn/ui 项目并打包为单文件 HTML,适合需要状态管理、路由或多组件交互的页面。
✎ 在 claude.ai 里做复杂网页 Artifact 很省心,多组件、状态和路由都能顺手搭起来,React、Tailwind 与 shadcn/ui 组合效率高、成品也更精致。
网页应用测试
by anthropics
用 Playwright 为本地 Web 应用编写自动化测试,支持启动开发服务器、校验前端交互、排查 UI 异常、抓取截图与浏览器日志,适合调试动态页面和回归验证。
✎ 借助 Playwright 一站式验证本地 Web 应用前端功能,调 UI 时还能同步查看日志和截图,定位问题更快。
相关 MCP Server
GitHub
编辑精选by GitHub
GitHub 是 MCP 官方参考服务器,让 Claude 直接读写你的代码仓库和 Issues。
✎ 这个参考服务器解决了开发者想让 AI 安全访问 GitHub 数据的问题,适合需要自动化代码审查或 Issue 管理的团队。但注意它只是参考实现,生产环境得自己加固安全。
Context7 文档查询
编辑精选by Context7
Context7 是实时拉取最新文档和代码示例的智能助手,让你告别过时资料。
✎ 它能解决开发者查找文档时信息滞后的问题,特别适合快速上手新库或跟进更新。不过,依赖外部源可能导致偶尔的数据延迟,建议结合官方文档使用。
by tldraw
tldraw 是让 AI 助手直接在无限画布上绘图和协作的 MCP 服务器。
✎ 这解决了 AI 只能输出文本、无法视觉化协作的痛点——想象让 Claude 帮你画流程图或白板讨论。最适合需要快速原型设计或头脑风暴的开发者。不过,目前它只是个基础连接器,你得自己搭建画布应用才能发挥全部潜力。