io.github.slima-ai/slima
编码与调试by slima-ai
面向Slima的MCP Server,提供适合小说作者的AI Writing IDE,并集成AI Beta Reader。
什么是 io.github.slima-ai/slima?
面向Slima的MCP Server,提供适合小说作者的AI Writing IDE,并集成AI Beta Reader。
README
Slima MCP
MCP (Model Context Protocol) Server for Slima - AI Writing IDE for Novel Authors.
Connect your Slima books to any MCP-compatible AI tool - one server, all platforms.
Supported Platforms
Desktop Applications (Local MCP - stdio)
| Platform | Status | Notes |
|---|---|---|
| Claude Desktop | ✅ | Native MCP support |
| ChatGPT Desktop | ✅ | Developer Mode (2025.10+) |
| Gemini CLI | ✅ | Native MCP support |
| Cursor | ✅ | Native MCP support |
| VS Code | ✅ | Via MCP extensions |
Web Applications (Remote MCP - HTTP)
| Platform | Status | Notes |
|---|---|---|
| Claude.ai | ✅ | OAuth login, no token needed |
| ChatGPT Web | ✅ | OAuth login, no token needed |
MCP became the industry standard in December 2025 when Anthropic, OpenAI, and Block co-founded the Agentic AI Foundation under the Linux Foundation.
Features
Book Management
- Create new books
- List and view your books
- Get file/folder structure
- Track writing statistics
File Operations
- Read any file by path
- Edit specific text (search & replace)
- Write (replace) file content
- Create new files
- Delete files
- Append content to files
- Search across all files
AI Beta Reader
- Get feedback from virtual reader personas
- Analyze chapters with different reader perspectives
Quick Start
Pick the path that matches how you use AI:
- ⭐ Use claude.ai / ChatGPT in a web browser → Recommended: web connector (one-time setup, auto-updates forever)
- Use Claude Desktop / Cursor / Gemini CLI locally → Local install with
npx - Running in air-gapped / enterprise environments → Self-host
Recommended: claude.ai / ChatGPT Web (auto-updating)
If you chat with Claude or ChatGPT in a browser, this is the easiest and most future-proof option. Configure once and you will automatically get every Slima MCP update — no upgrade commands, no config edits.
MCP URL: https://mcp.slima.ai/mcp
claude.ai (Pro / Max / Team / Enterprise)
- Sign in at claude.ai.
- Open Settings → Connectors (or Integrations depending on your plan).
- Click Add custom connector.
- Fill in:
- Name:
Slima - URL:
https://mcp.slima.ai/mcp
- Name:
- Click Connect → you will be redirected to slima.ai to approve → return to claude.ai.
- The Slima tools icon appears in your chat input. You're done.
ChatGPT (Plus / Pro, Developer Mode)
- Sign in at chatgpt.com.
- Open Settings → Connectors → Advanced and toggle Developer Mode on (2025.10+).
- Back in Connectors, click Create → Custom MCP Server.
- Fill in:
- Name:
Slima - Server URL:
https://mcp.slima.ai/mcp - Authentication: OAuth
- Name:
- Click Create → approve the OAuth flow.
After setup, Slima features roll out automatically on your next conversation. No restarts, no reinstalls.
Local: Claude Desktop / Cursor / Gemini CLI
Use this if you want offline-friendly operation, faster startup, or you need to run MCP alongside other stdio servers.
Recommended config — pinned to the major version so you pick up new features automatically but never break on a 1.0 release:
Claude Desktop
Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"slima": {
"command": "npx",
"args": ["-y", "slima-mcp@0"],
"env": {
"SLIMA_API_TOKEN": "slima_your_token_here"
}
}
}
}
Get your token from Slima Settings or run npx slima-mcp@0 auth once to save it to disk.
Cursor
{
"mcpServers": {
"slima": {
"command": "npx",
"args": ["-y", "slima-mcp@0"],
"env": {
"SLIMA_API_TOKEN": "slima_your_token_here"
}
}
}
}
Gemini CLI
gemini mcp add slima --command "npx -y slima-mcp@0"
Why
slima-mcp@0instead ofslima-mcp/slima-mcp@latest? Using@0pins to the current major version — npx still fetches new0.x.yreleases automatically (so you get features + bug fixes), but when we ship1.0.0with breaking changes you won't silently pick it up without updating your config. We'll announce the@1switch in the release notes.
Migrating from a global install
If you already installed globally with npm install -g slima-mcp:
# Remove the old global install (optional but cleaner)
npm uninstall -g slima-mcp
# Change your config `command` from "slima-mcp" to the npx form above, and restart the client.
Or, if you want to stay on a global install, remember to periodically run:
npm install -g slima-mcp@latest
Otherwise your local client will drift from the MCP tools/schema the Slima backend exposes.
Self-host (advanced)
You can also clone this repo and deploy the Cloudflare Worker yourself. See wrangler.toml + npm run deploy:worker. Not required for normal use.
Remote MCP Security
The hosted Remote MCP Server at https://mcp.slima.ai/mcp uses:
- OAuth 2.0 + PKCE for authentication — no tokens copy-pasted.
- No secrets stored server-side — credentials never leave Slima's auth server.
- Session-based: OAuth tokens are stored in Cloudflare KV, scoped per session.
- Revocable anytime from Slima Settings.
Book Types: Writing Studio vs Script Studio
Slima books come in two flavors, distinguished by the book_type field. MCP behaves slightly differently for each:
📖 Writing Studio (book_type: "book") | 📝 Script Studio (book_type: "script") | |
|---|---|---|
| Creation via MCP | ✅ create_book works | ❌ use the Slima app UI |
| Read (any file) | ✅ | ✅ |
| Write / Edit / Delete | ✅ any path | ✅ only under .script_studio/planning/**/* |
Structured files (series.json, *.character, *.scene, *.storyline, *.note, *.location, season.json, episode.json) | n/a | ❌ read-only via MCP — edits must go through the Script Studio UI |
analyze_chapter (AI Beta Reader) | ✅ | ❌ not yet supported on structured scenes |
search_content | all files | structured files excluded by default; pass include_structured: true to include them |
For per-book details, ask your AI client to read the resource slima://books/{book_token}/schema — it returns a JSON spec of exactly which paths are writable/read-only for that specific book.
list_books tags every book with its studio icon (📝 / 📖) so you (and the AI) can tell them apart at a glance.
Available Tools
Book Management
| Tool | Description |
|---|---|
create_book | Create a new book in your library |
list_books | List all books in your Slima library |
get_book | Get details of a specific book |
get_book_structure | Get the file/folder structure of a book |
get_writing_stats | Get writing statistics for a book |
File Operations
| Tool | Description |
|---|---|
read_file | Read content of any file by path |
edit_file | Edit specific text using search & replace |
write_file | Replace entire content of a file |
create_file | Create a new file in a book |
delete_file | Delete a file from a book |
append_to_file | Append content to end of a file |
search_content | Search for text across all files |
AI Beta Reader
| Tool | Description |
|---|---|
list_personas | List available beta reader personas |
analyze_chapter | Get AI beta reader feedback on a chapter |
Usage Examples
Once configured, you can ask your AI:
Book & Content:
- "Create a new book called 'My Novel'"
- "List my books in Slima"
- "Show me the structure of my novel"
- "Read chapter 3 of my book"
- "What are my writing stats?"
File Operations:
- "Read the character profile for my protagonist"
- "Edit chapter 1 and change 'John' to 'James'"
- "Create a new file called worldbuilding.md with notes about the magic system"
- "Search for all mentions of 'blue eyes' in my book"
- "Append this new paragraph to chapter 5"
AI Feedback:
- "Get feedback on chapter 5 from a young reader perspective"
- "Analyze my opening scene from a critic's perspective"
CLI Commands
slima-mcp auth # Authenticate with browser (recommended)
slima-mcp status # Check authentication status
slima-mcp logout # Remove saved credentials
slima-mcp --help # Show help
slima-mcp --version # Show version
Token is stored in ~/.slima/credentials.json with secure permissions.
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
SLIMA_API_TOKEN | No* | - | Your Slima API token |
SLIMA_API_URL | No | https://api.slima.ai | API endpoint (for development) |
DEBUG | No | false | Enable debug logging |
*Not required if you used slima-mcp auth
Development
Local CLI Development
# Clone the repository
git clone https://github.com/slima-ai/slima-mcp.git
cd slima-mcp
# Install dependencies
npm install
# Build CLI
npm run build
# Run tests
npm test
# Run in development mode
npm run dev
Cloudflare Worker Development
# Build the Worker
npm run build:worker
# Run Worker locally
npm run dev:worker
# Deploy to Cloudflare
npm run deploy:worker
# Deploy to preview environment
npm run deploy:worker:preview
Project Structure
slima-mcp/
├── src/
│ ├── core/ # Shared core modules
│ │ ├── api/ # Slima API Client
│ │ ├── tools/ # MCP Tool implementations
│ │ └── utils/ # Utilities and errors
│ ├── cli/ # CLI entry point (stdio transport)
│ │ ├── index.ts # CLI main
│ │ ├── auth.ts # Authentication commands
│ │ └── server.ts # MCP Server for CLI
│ └── worker/ # Cloudflare Worker (HTTP transport)
│ ├── index.ts # Worker entry point
│ └── oauth.ts # OAuth 2.0 + PKCE client
├── wrangler.toml # Cloudflare Worker config
├── tsup.config.ts # CLI build config
└── tsup.worker.config.ts # Worker build config
Security
- API tokens are stored locally and never shared
- All communication with Slima API uses HTTPS
- Tokens can be revoked anytime from Slima settings
Release & Deployment
npm (Automatic)
Merge to main with a version bump in package.json triggers automatic npm publish via GitHub Actions.
# 1. Bump version on dev branch
npm version patch # 0.1.10 → 0.1.11
# 2. Merge to main
git checkout main && git merge dev && git push
# 3. CI runs tests → publish.yml publishes to npm + creates git tag
Cloudflare Worker (Manual)
Worker deployment is separate from npm. Deploy after code changes:
npm run deploy:worker # Production (mcp.slima.ai)
npm run deploy:worker:preview # Staging
MCP Registry (Manual)
To publish/update the server listing on the MCP Registry:
mcp-publisher login github
mcp-publisher publish
Requires mcpName in package.json and server.json in repo root.
Operational Notes
Debugging Worker OAuth
When troubleshooting claude.ai or ChatGPT connector issues:
# Live logs from production Worker
wrangler tail slima-mcp
All OAuth endpoints log key parameters (client_id, redirect_uri, token prefix, etc.) to help trace the flow.
Worker OAuth Flow (claude.ai / ChatGPT)
Client POST /mcp → 401 + WWW-Authenticate header
→ Client GET /.well-known/oauth-protected-resource
→ Client GET /.well-known/oauth-authorization-server
→ Client POST /register (DCR)
→ Client redirects user to GET /authorize
→ Worker redirects to Rails OAuth
→ User authorizes → Rails redirects to Worker /callback
→ Worker issues auth code → redirects to client callback
→ Client POST /token (exchange code for access_token)
→ Client POST /mcp (Authorization: Bearer {access_token})
Known Constraints
- Worker Bearer token validation accepts all non-empty tokens (not just
slima_prefix) to support OAuth-issued tokens. Rails API performs actual validation. getTokenFromSession()checks Authorization header first, then falls back to cookie session.- MCP Inspector (
npx @modelcontextprotocol/inspector) is useful for testing the full OAuth flow independently.
License
MIT
Links
常见问题
io.github.slima-ai/slima 是什么?
面向Slima的MCP Server,提供适合小说作者的AI Writing IDE,并集成AI Beta Reader。
相关 Skills
前端设计
by anthropics
面向组件、页面、海报和 Web 应用开发,按鲜明视觉方向生成可直接落地的前端代码与高质感 UI,适合做 landing page、Dashboard 或美化现有界面,避开千篇一律的 AI 审美。
✎ 想把页面做得既能上线又有设计感,就用前端设计:组件到整站都能产出,难得的是能避开千篇一律的 AI 味。
网页应用测试
by anthropics
用 Playwright 为本地 Web 应用编写自动化测试,支持启动开发服务器、校验前端交互、排查 UI 异常、抓取截图与浏览器日志,适合调试动态页面和回归验证。
✎ 借助 Playwright 一站式验证本地 Web 应用前端功能,调 UI 时还能同步查看日志和截图,定位问题更快。
网页构建器
by anthropics
面向复杂 claude.ai HTML artifact 开发,快速初始化 React + Tailwind CSS + shadcn/ui 项目并打包为单文件 HTML,适合需要状态管理、路由或多组件交互的页面。
✎ 在 claude.ai 里做复杂网页 Artifact 很省心,多组件、状态和路由都能顺手搭起来,React、Tailwind 与 shadcn/ui 组合效率高、成品也更精致。
相关 MCP Server
GitHub
编辑精选by GitHub
GitHub 是 MCP 官方参考服务器,让 Claude 直接读写你的代码仓库和 Issues。
✎ 这个参考服务器解决了开发者想让 AI 安全访问 GitHub 数据的问题,适合需要自动化代码审查或 Issue 管理的团队。但注意它只是参考实现,生产环境得自己加固安全。
Context7 文档查询
编辑精选by Context7
Context7 是实时拉取最新文档和代码示例的智能助手,让你告别过时资料。
✎ 它能解决开发者查找文档时信息滞后的问题,特别适合快速上手新库或跟进更新。不过,依赖外部源可能导致偶尔的数据延迟,建议结合官方文档使用。
by tldraw
tldraw 是让 AI 助手直接在无限画布上绘图和协作的 MCP 服务器。
✎ 这解决了 AI 只能输出文本、无法视觉化协作的痛点——想象让 Claude 帮你画流程图或白板讨论。最适合需要快速原型设计或头脑风暴的开发者。不过,目前它只是个基础连接器,你得自己搭建画布应用才能发挥全部潜力。