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 整合