StartOS SDK MCP
模型上下文协议（MCP）服务器和使用StartOS SDK v0.4.0开发StartOS服务包的全面文档。
概述
该存储库为创建StartOS服务包提供了人工智能辅助开发工具和全面的文档。它包括：
- MCP服务器 -用于人工智能辅助的工作模型上下文协议服务器
- 完整的API参考资料 -StartOS SDK v0.4.0的完整文档
- 常见模式 -来自21+生产服务的最佳实践
- 示例服务 -作为git子模块的现实世界实现
- 代理说明 -人工智能辅助开发指南
快速开始
在Claude Desktop中使用MCP服务器
# 1. Install dependencies
npm install
# 2. Build the server
npm run build
# 3. Configure Claude Desktop (see INSTALLATION.md for details)
# Add this repo to your claude_desktop_config.json
# 4. Restart Claude Desktop completely
# 5. Start developing with AI assistance!看 安装.md 有关完整的设置说明。
存储库结构
startOS-sdk-mcp/
├── README.md # This file
├── INSTALLATION.md # Setup and usage guide
├── AGENT.md # Agent instructions
├── SDK_API_REFERENCE.md # Complete SDK API documentation
├── COMMON_PATTERNS.md # Patterns from production services
├── MCP_IMPLEMENTATION_PLAN.md # MCP server implementation plan
├── package.json # MCP server dependencies
├── tsconfig.json # TypeScript configuration
├── src/ # MCP server source code
│ ├── index.ts # Server entry point
│ ├── resources.ts # Resource handlers
│ └── utils/
│ └── logger.ts # Logging (stderr only)
└── services/ # Example services (git submodules)
├── hello-world-startos/ # Simple example (SDK v0.4.0)
├── home-assistant-startos/ # Multi-volume example
├── bitcoin-core-startos/ # Complex blockchain node
├── cln-startos/ # Advanced configuration
├── mempool-startos/ # Multi-container service
├── lnd-startos/ # P2P service
├── electrs-startos/ # Service with dependencies
├── lnbits-startos/ # Optional dependencies
├── jellyfin-startos/ # Volume pointers
├── vaultwarden-startos/ # Password manager
├── ghost-startos/ # CMS with database
├── jam-startos/ # CoinJoin coordinator
├── nostr-rs-relay-startos/ # Nostr relay
├── albyhub-startos/ # Lightning wallet
├── searxng-startos/ # Meta search engine
├── nostrudel-startos/ # Nostr client
├── start9-pages-startos/ # Static site hosting
├── cal.com-startos/ # Scheduling platform
├── lightning-terminal-startos/ # Lightning terminal
├── ride-the-lightning-startos/ # Lightning management
├── fedimint-startos/ # Federated mint
└── gitea-startos/ # Git hosting文档
对于开发者
从这里开始：
- 阅读 AGENT.md -概述和使用指南
- 审查 SDK_API_REFERENCE.md -完整的API文件
- 学习 COMMON_PATTERNS.md -最佳做法
快速入门：
# Clone with submodules
git clone --recursive https://github.com/your-org/startOS-sdk-mcp.git
# Or if already cloned
git submodule update --init --recursive
# Browse example services
cd services/hello-world-startosAI助理
看 AGENT.md 用于：
- 如何协助服务开发
- 常见任务和模式
- 代码生成指南
- 故障排除工作流
主要特点
📚 综合文档
- SDK API参考：记录了每个类、方法、类型和模式
- 常见模式：来自21+生产服务的真实世界模式
- 代码示例：来自久经考验的服务的数百个示例
- 最佳实践：基于系统分析的建议
🔍 示例服务
所有示例都以git子模块的形式提供，便于探索：
简单服务 （非常适合学习）：
hello-world-startos-最小工作示例home-assistant-startos-多卷服务
高级服务 （适用于复杂图案）：
cln-startos-700+行配置mempool-startos-多容器架构bitcoin-core-startos-复杂区块链节点
集成服务 （对于依赖关系）：
electrs-startos-所需依赖关系示例lnbits-startos-可选依赖模式jellyfin-startos-卷指针集成
🛠️ MCP实施计划
建筑开发工具的详细规范：
第一阶段：核心基础设施
- MCP服务器设置
- 资源端点
- 文档访问
第二阶段：脚手架工具
- 服务生成
- 配置规范生成器
- 依赖关系管理器
- 界面配置器
- 动作发生器
第3阶段：验证工具
- 清单验证
- 配置规范验证
- 服务业
阶段4：迁移工具
- 遗留服务分析
- SDK v0.3.x→ v0.4.0迁移
- 自动转换
第5-7阶段：增强工具
- 代码生成助手
- 文档生成器
- 模式搜索和比较
看 MCP_实施_计划.md 了解完整细节。
用法
面向人类开发人员
- 浏览文档
# Read API reference
cat SDK_API_REFERENCE.md
# Study common patterns
cat COMMON_PATTERNS.md
# Follow agent guide
cat AGENT.md- 探索示例
# Look at simple example
cd services/hello-world-startos
cat startos/index.ts
# Study complex configuration
cd services/cln-startos
find startos -name "*.ts"- 搜索模式
# Find all services using unions
grep -r "Value.union" services/
# Find dependency examples
grep -r "setupDependencies" services/AI助理
使用StartOS SDK时：
- 先查阅文件
- 查看SDK_API_REFERENCE.md了解API详细信息 - 查看COMMON_PATTERNS.md以了解经过验证的方法 - 实际实现的参考示例服务
- 生成代码
- 使用COMMON_PATTERNS.md中的模板 - 遵循文件结构惯例 - 应用类型安全最佳实践
- 验证方法
- 与示例服务进行比较 - 对照常见模式进行检查 - 确保遵循最佳实践
- 提供上下文
- 使用行号引用特定文件 - 指向相关示例服务 - 引用文档部分
看 AGENT.md 详细说明。
分析方法
本文档是通过系统分析创建的：
- SDK源代码分析
- 全面检查 ~/code/start-os/sdk/ 关于v0.4.0-α13的分支 - 记录所有具有源位置的公共API - 提取的类型定义和模式
- 服务存储库审查
- 分析了21个生产服务 - 确定了常见的模式和变化 - 最佳实践和反模式编目 - 找到样板候选人
- 模式提取
- 比较实施方法 - 识别出的常用模式 - 记录配置策略 - 分析依赖关系管理 - 研究了健康检查的实施 - 检查备份/恢复策略
开发状态
✅ 完成
- 存储库设置
- 示例服务集合（21个服务作为子模块）
- SDK源代码分析
- 系统性服务评审
- API参考文件
- 常见模式文档
- 代理商说明
- MCP实施计划
- MCP服务器第0阶段：基础
- ✅ STDIO传输服务器 - ✅ 正确的日志记录（仅限stderr） - ✅ 资源端点（文档访问） - ✅ 基本工具（列表示例、搜索模式）
🚧 进行中
- MCP服务器第1-7阶段：高级功能（请参阅MCP_Implement_PLAN.md）
- 脚手架工具 - 验证工具 - 移民助理
📋 计划的
- 代码生成工具
- 验证工具
- 移民助理
- 交互式脚手架
- 模式搜索工具
贡献
添加示例
要添加新的示例服务，请执行以下操作：
git submodule add https://github.com/Start9Labs/service-name-startos services/service-name-startos
git commit -m "Add service-name-startos example"更新文档
更新文档时：
- 保持一致的格式
- 包括代码示例
- 参考源位置
- 测试所有代码片段
- 更新目录
报告问题
发现错误或有建议？
- 检查现有问题
- 创建详细的错误报告或功能请求
- 包括相关背景和示例
资源
官方文件
示例存储库
所有示例服务均来自 :
- 每种服务都展示了不同的模式
- 所有这些都是生产就绪的实施
- 涵盖广泛的复杂性级别
SDK源代码
SDK源代码位于 ~/code/start-os/sdk/ 在分行 v0.4.0-alpha.13:
sdk/base/-核心SDK功能sdk/package/-高级包构建API
许可证
此文档存储库：MIT许可证
单个服务示例：请参阅每个子模块中的相应LICENSE文件。
StartOS SDK：请参阅 Start9Labs/启动操作系统许可证
致谢
- Start9Labs用于创建StartOS和SDK
- 示例服务的所有贡献者
- StartOS社区用于反馈和测试
支持
- 文档问题：在此存储库中创建问题
- SDK问题： Start9Labs/启动操作系统问题
- 社区支持： Start9社区
______________________________________________________________________
版本: 0.1.0 最后更新: 2025-11-18 SDK版本：v0.4.0-α13