CleanSlice

io.github.CleanSlice由 GitHub 账号 CleanSlice 发布v1.0.0更新于 Oct 24, 2026

Architecture docs and patterns for NestJS + Nuxt full-stack apps

发布方自己的服务:Slice

已验证Streamable HTTP可网页运行知识与记忆开发者工具

概览

AI 生成的概览

一个远程 MCP 服务器,为编码助手提供 NestJS 与 Nuxt 全栈应用的 CleanSlice 架构文档,使其遵循相应约定。

可以做什么
通过 get-started 加载 CleanSlice 核心规则与命名约定,服务器要求写代码前先调用它。用 list-categories 查看可用的文档分类。按查询文本、框架、阶段、功能、分类或标签搜索文档,返回简短片段和文档路径。需要完整内容时,按路径用 read-doc 读取指定文档全文。
适用场景
适合在构建或修改遵循 CleanSlice 约定的 NestJS 与 Nuxt 全栈应用时使用,让助手查阅项目架构文档,而不是猜测命名和结构。
运行要求
远程 streamable HTTP 端点;未声明任何软件包、账号、密钥或请求头。README 另述用 Bun 和 Docker 本地运行的方式,此时可选变量如 PORT、DOCS_PATH、GITHUB_REPO、GITHUB_TOKEN 和 CORS_ORIGIN 生效。
安装前请注意
仅提供只读文档访问,托管端点不索取凭据。README 建议添加项目规则和 Stop 钩子,强制助手在写代码前先查询此服务器,这会改变代理工作流程,采用前应先行审阅。

安装

在 SourceWeft 中

  1. 打开 控制台中的 CleanSlice,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/io.github.CleanSlice%2Fmcp/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。

{
  "mcpServers": {
    "cleanslice": {
      "type": "http",
      "url": "https://mcp.cleanslice.org/mcp"
    }
  }
}

README

CleanSlice MCP Server

[Install 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

Install in Claude Code

Run this command. See Claude Code MCP docs for more info.

sh
claude mcp add --scope user --transport http cleanslice https://mcp.cleanslice.org/mcp

Remove --scope user to 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:

markdown
## 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:

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."          }        ]      }    ]  }}
Install in Cursor

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.

json
{  "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:

markdown
---description: CleanSlice architecture rulesglobs: **/*.{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.
Install in Windsurf

Add to your Windsurf MCP config file. See Windsurf MCP docs for more info.

json
{  "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:

markdown
## 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.
Install in VS Code (Copilot)

Add to .vscode/mcp.json in your project. See VS Code MCP docs for more info.

json
{  "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:

markdown
## 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.
Install in Claude Desktop

Add to your claude_desktop_config.json. See Claude Desktop MCP docs for more info.

json
{  "mcpServers": {    "cleanslice": {      "type": "http",      "url": "https://mcp.cleanslice.org/mcp"    }  }}
Install in Opencode

Add this to your Opencode configuration file. See Opencode MCP docs for more info.

json
{  "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:

markdown
## 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.
Run Locally
bash
git clone https://github.com/CleanSlice/mcp.gitcd mcpbun installbun run dev

Then point your MCP client to http://localhost:8080/mcp.

Available Tools

ToolDescription
get-startedReturns the essential CleanSlice rules and conventions. Call this first.
list-categoriesLists all documentation categories available for search filtering
searchSearch docs by query, category, framework, phase, or tags. Returns snippets (keyword-in-context excerpts) and document paths
read-docRead the full content of a specific document by path. Use after search to get complete docs

Recommended workflow

get-started            → learn the core ruleslist-categories        → discover what's availablesearch(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

VariableDefaultDescription
PORT8080Server port
NODE_ENV-Set to dev for debug/verbose logging
DOCS_PATHAuto-discoverPath to bundled docs directory
GITHUB_REPOCleanSlice/docsFallback GitHub repo for docs
GITHUB_BRANCHmainGitHub branch to fetch from
GITHUB_TOKEN-GitHub token (optional, for higher rate limits)
GITHUB_CACHE_TTL3600GitHub content cache TTL in seconds
CORS_ORIGIN*Allowed CORS origin(s)

Docker

bash
docker build -t cleanslice-mcp .docker run -p 8080:8080 cleanslice-mcp

Endpoints

EndpointDescription
GET /sseSSE transport (for Claude Desktop, Cursor)
POST /messagesSSE message handler
POST /mcpStreamable HTTP transport
GET /healthHealth check
GET /apiSwagger docs

Architecture documentation synchronization

The four reliability guides in docs/architecture/ are generated from the website repository's docs/architecture/ files (sibling checkout ../docs/docs/architecture). Run node scripts/sync-architecture-docs.mjs after editing the canonical docs and node scripts/sync-architecture-docs.mjs --check before release. For another checkout layout pass --source=/absolute/path/to/architecture. The check fails on missing or divergent copies. Commit the generated bundle with the MCP change so standalone deployments can search/read the same versioned content.

get-started loads 00-quickstart/get-started.md directly, with local-first/remote fallback. If unavailable it fails explicitly rather than returning empty rules. The bundled-knowledge integration tests exercise real loading, searching and rendered startup content. Updating files locally does not update the hosted MCP: build/test, publish the docs and deploy the MCP through the normal authorized release process.

来源:README.md,提交 e49f946

工具

4

get-started

⚠️ CRITICAL: request this tool first before creating any code! Returns essential slice creation rules. READ THIS FIRST before creating any slices! Contains the MOST IMPORTANT naming rule: ALWAYS use SINGULAR names (user/ not users/).

无需输入参数。

list-categories

List all available documentation categories. Use this to discover what categories are available before searching.

无需输入参数。

read-doc

Read the full content of a specific document by path. Use this after `search` to get the complete document when snippets are not enough.

输入参数path必填

版本历史

1
  1. v1.0.0最新Sep 16, 2026

评分

已满足适用检查项的 100%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

其他 Slice 集成