Buildable MCP Server
ทางการเซิร์ฟเวอร์ MCP อย่างเป็นทางการสำหรับแพลตฟอร์มพัฒนา AI-powered Buildable ช่วยให้ผู้ช่วย AI จัดการงาน ติดตามความคืบหน้า รับบริบทของโปรเจกต์ และทำงานร่วมกับมนุษย์ในโปรเจกต์ซอฟต์แวร์
เอกสาร
@bldbl/mcp
ไคลเอนต์ MCP อย่างเป็นทางการสำหรับ Buildable - แพลตฟอร์มการพัฒนาที่ขับเคลื่อนด้วย AI ซึ่งทำให้ทุกโปรเจกต์สามารถสร้างได้
แพ็คเกจนี้ช่วยให้ผู้ช่วย AI (Claude, GPT ฯลฯ) สามารถทำงานร่วมกับโปรเจกต์ Buildable ได้โดยตรงโดยใช้ Model Context Protocol (MCP) ผู้ช่วย AI สามารถรับบริบทของโปรเจกต์ จัดการงาน ติดตามความคืบหน้า และสื่อสารกับนักพัฒนาที่เป็นมนุษย์ได้
🌟 Buildable คืออะไร?
Buildable (bldbl.dev) เป็นแพลตฟอร์มการพัฒนาที่ขับเคลื่อนด้วย AI ซึ่งทำให้ทุกโปรเจกต์สามารถสร้างได้ โดยมี:
- แผนการสร้างที่สร้างโดย AI: โรดแมปโปรเจกต์ที่ครอบคลุมพร้อมรายละเอียดการนำไปใช้
- การจัดการงานอัจฉริยะ: การแบ่งงานอัตโนมัติพร้อมการพึ่งพาและลำดับความสำคัญ
- การผสานรวมผู้ช่วย AI: การผสานรวมโดยตรงกับ Claude, GPT และผู้ช่วย AI อื่นๆ
- การทำงานร่วมกันแบบเรียลไทม์: การทำงานร่วมกันระหว่างมนุษย์กับ AI อย่างราบรื่นในโปรเจกต์ที่ซับซ้อน
- การติดตามความคืบหน้า: การตรวจสอบความคืบหน้าในการพัฒนาและอุปสรรคแบบสด
🚀 ฟีเจอร์
- การผสานรวมโปรเจกต์เต็มรูปแบบ: รับบริบทโปรเจกต์ แผน และรายละเอียดงานทั้งหมด
- การจัดการงานอัตโนมัติ: เริ่ม อัปเดตความคืบหน้า และทำงานให้เสร็จสมบูรณ์
- การทำงานร่วมกับมนุษย์: สร้างการสนทนาสำหรับคำถามและอุปสรรค
- การติดตามความคืบหน้าแบบเรียลไทม์: การอัปเดตสดและการตรวจสอบสถานะ
- API แบบ Type-Safe: รองรับ TypeScript เต็มรูปแบบพร้อมคำจำกัดความประเภทที่ครอบคลุม
- พร้อมใช้งานกับ Claude Desktop: อินเทอร์เฟซ CLI สำหรับการผสานรวม Claude Desktop อย่างราบรื่น
📦 การติดตั้ง
การติดตั้งผ่าน Smithery
เพื่อติดตั้ง @bldbl/mcp สำหรับ Claude Desktop โดยอัตโนมัติผ่าน Smithery:
npx -y @smithery/cli install @buildable/bldbl-mcp --client claude
การติดตั้งด้วยตนเอง
npm install @bldbl/mcp
🚀 เริ่มต้นอย่างรวดเร็ว
ขั้นตอนที่ 1: ติดตั้ง MCP Server
npm install -g @bldbl/mcp
ขั้นตอนที่ 2: รับ API Key ของ Buildable
- ไปที่ bldbl.dev และสร้างบัญชี
- สร้างหรือเลือกโปรเจกต์
- ไปที่ Project Settings → AI Assistants → Generate API Key
ขั้นตอนที่ 3: กำหนดค่าผู้ช่วย AI ของคุณ
🤖 สำหรับ Claude Desktop:
เพิ่มสิ่งนี้ลงในไฟล์กำหนดค่า Claude Desktop ของคุณ (~/.config/claude/claude_desktop_config.json):
{
"mcpServers": {
"buildable": {
"command": "npx",
"args": ["-y", "@bldbl/mcp"],
"env": {
"BUILDABLE_API_KEY": "bp_your_api_key_here",
"BUILDABLE_PROJECT_ID": "your-project-id",
"BUILDABLE_AI_ASSISTANT_ID": "claude-desktop"
}
}
}
}
การตั้งค่าขั้นต่ำ - ตรวจพบ URL API โดยอัตโนมัติเท่านั้น
✨ สำหรับ Cursor AI:
ตัวเลือกที่ 1: การตั้งค่าด้วยคลิกเดียว (แนะนำ)
- ไปที่โปรเจกต์ของคุณบน bldbl.dev
- ไปที่ Integrations
- คลิก "Add to Cursor" - เสร็จสิ้น! 🎉
ตัวเลือกที่ 2: การกำหนดค่าด้วยตนเอง เพิ่มสิ่งนี้ลงในไฟล์กำหนดค่า Cursor AI ของคุณ:
{
"mcpServers": {
"buildable": {
"command": "npx",
"args": ["-y", "@bldbl/mcp"],
"env": {
"BUILDABLE_API_KEY": "bp_your_api_key_here",
"BUILDABLE_PROJECT_ID": "your-project-id",
"BUILDABLE_AI_ASSISTANT_ID": "cursor-ide"
}
}
}
}
การตั้งค่าขั้นต่ำ - ตรวจพบ URL API โดยอัตโนมัติเท่านั้น
ขั้นตอนที่ 4: เริ่มการพัฒนาที่ขับเคลื่อนด้วย AI!
เมื่อกำหนดค่าแล้ว ผู้ช่วย AI ของคุณจะสามารถเข้าถึงเครื่องมืออันทรงพลังเหล่านี้:
- 🏗️
get_project_context- ทำความเข้าใจโครงสร้างโปรเจกต์ทั้งหมดของคุณ - 📋
get_next_task- ค้นหาสิ่งที่ต้องทำต่อไปตามลำดับความสำคัญ - ▶️
start_task- เริ่มทำงานในงานที่ระบุ - 📊
update_progress- รายงานการอัปเดตความคืบหน้าโดยละเอียด - ✅
complete_task- ทำเครื่องหมายงานว่าเสร็จสิ้นพร้อมบันทึกที่ครอบคลุม - 💬
create_discussion- ถามคำถามเมื่อคุณต้องการข้อมูลจากมนุษย์ - 🔍
health_check- ตรวจสอบการเชื่อมต่อกับ Buildable
💡 ตัวอย่างการสนทนากับ AI:
You: "What should I work on next in my project?"
AI: *calls get_project_context & get_next_task*
"I see you're building a React dashboard app. The next
high-priority task is 'Implement user authentication'.
Should I start working on it?"
You: "Yes, go ahead!"
AI: *calls start_task*
"Perfect! I'm starting the authentication task. I'll use
NextAuth.js with GitHub OAuth. Let me break this down:
1. Install dependencies
2. Set up NextAuth config
3. Create login/logout components
4. Add protected routes
I'll update you on progress as I work!"
[AI works and calls update_progress periodically]
AI: *calls update_progress*
"Progress update: 75% complete! I've implemented:
✅ NextAuth.js configuration
✅ GitHub OAuth provider setup
✅ Login/logout components
🔄 Currently working on: Protected route middleware
Should I continue with the remaining work?"
🔧 การกำหนดค่าขั้นสูง
ตัวแปรสภาพแวดล้อม
แนะนำให้ใช้ตัวแปรสภาพแวดล้อม 3 ตัวสำหรับการติดตามผู้ช่วย AI ที่เหมาะสม:
export BUILDABLE_API_KEY="bp_your_api_key_here" # Your API key (required)
export BUILDABLE_PROJECT_ID="your-project-id" # Target project (required)
export BUILDABLE_AI_ASSISTANT_ID="my-ai-assistant" # AI Assistant ID (recommended)
# Optional (has smart default):
# export BUILDABLE_API_URL="https://bldbl.dev/api" # API endpoint (default)
เหตุใด AI Assistant ID จึงสำคัญ: สิ่งนี้ช่วยให้คุณติดตามว่าผู้ช่วย AI ตัวใดกำลังทำงานอะไรในแดชบอร์ดโปรเจกต์ของคุณ
การใช้งาน CLI
คุณยังสามารถรัน MCP server ได้โดยตรง:
# Install globally and use bldbl command
npm install -g @bldbl/mcp
bldbl
# Or run with npx (no installation needed)
npx @bldbl/mcp
หลายโปรเจกต์
ในการทำงานกับหลายโปรเจกต์ Buildable ให้สร้างการกำหนดค่า MCP server ที่แตกต่างกัน:
{
"mcpServers": {
"buildable-frontend": {
"command": "npx",
"args": ["-y", "@bldbl/mcp"],
"env": {
"BUILDABLE_API_KEY": "bp_frontend_key_here",
"BUILDABLE_PROJECT_ID": "frontend-project-id",
"BUILDABLE_AI_ASSISTANT_ID": "claude-frontend"
}
},
"buildable-backend": {
"command": "npx",
"args": ["-y", "@bldbl/mcp"],
"env": {
"BUILDABLE_API_KEY": "bp_backend_key_here",
"BUILDABLE_PROJECT_ID": "backend-project-id",
"BUILDABLE_AI_ASSISTANT_ID": "claude-backend"
}
}
}
}
🛠️ เอกสารอ้างอิง API
BuildPlannerMCPClient
คลาสไคลเอนต์หลักสำหรับการโต้ตอบกับโปรเจกต์ Buildable
ตัวสร้าง
new BuildPlannerMCPClient(config: BuildPlannerConfig, options?: ClientOptions)
พารามิเตอร์การกำหนดค่า:
apiUrl: URL API ของ Buildable (ค่าเริ่มต้นคือ 'https://bldbl.dev/api')apiKey: API key ของ Buildable ของคุณ (ขึ้นต้นด้วย 'bp_')projectId: ID โปรเจกต์เป้าหมายaiAssistantId: ตัวระบุเฉพาะสำหรับผู้ช่วย AI ของคุณtimeout: หมดเวลาคำขอในหน่วยมิลลิวินาที (ค่าเริ่มต้น: 30000)
ตัวเลือก:
retryAttempts: จำนวนครั้งที่ลองใหม่ (ค่าเริ่มต้น: 3)retryDelay: ระยะหน่วงระหว่างการลองใหม่ในหน่วย ms (ค่าเริ่มต้น: 1000)
เมธอด
getProjectContext(): Promise<ProjectContext>
รับบริบทโปรเจกต์ทั้งหมดรวมถึงแผน งาน และกิจกรรมล่าสุด
getNextTask(): Promise<NextTaskResponse>
รับงานที่แนะนำถัดไปให้ทำตามการพึ่งพาและลำดับความสำคัญ
startTask(taskId: string, options?: StartTaskOptions): Promise<StartTaskResponse>
เริ่มทำงานในงานที่ระบุพร้อมแนวทางและการประมาณเวลาเพิ่มเติม
updateProgress(taskId: string, progress: ProgressUpdate): Promise<ProgressResponse>
อัปเดตความคืบหน้าของงานปัจจุบันพร้อมข้อมูลสถานะโดยละเอียด
completeTask(taskId: string, completion: CompleteTaskRequest): Promise<CompleteTaskResponse>
ทำเครื่องหมายงานว่าเสร็จสมบูรณ์พร้อมข้อมูลการเสร็จสมบูรณ์โดยละเอียด
createDiscussion(discussion: CreateDiscussionRequest): Promise<DiscussionResponse>
สร้างการสนทนา/คำถามสำหรับข้อมูลจากมนุษย์เมื่อคุณต้องการคำแนะนำ
healthCheck(): Promise<{status: string, timestamp: string}>
ตรวจสอบการเชื่อมต่อและความสมบูรณ์ของ API Buildable
disconnect(): Promise<void>
ตัดการเชื่อมต่อและล้างข้อมูลการเชื่อมต่อไคลเอนต์อย่างเหมาะสม
🔐 การตรวจสอบสิทธิ์
- สร้าง API Key: ไปที่โปรเจกต์ Buildable ของคุณ → แท็บ AI Assistant → Generate API Key
- การจัดเก็บที่ปลอดภัย: จัดเก็บ API key ของคุณอย่างปลอดภัย (แนะนำให้ใช้ตัวแปรสภาพแวดล้อม)
- รูปแบบ Key: API keys ขึ้นต้นด้วย
bp_ตามด้วยโปรเจกต์และตัวระบุแบบสุ่ม
🐛 การจัดการข้อผิดพลาด
ไคลเอนต์รวมการจัดการข้อผิดพลาดที่ครอบคลุม:
try {
const context = await client.getProjectContext();
} catch (error) {
if (error.code === 'UNAUTHORIZED') {
console.error('Invalid or expired API key');
} else if (error.code === 'PROJECT_NOT_FOUND') {
console.error('Project not found or access denied');
} else {
console.error('API error:', error.message);
}
}
🔄 ขั้นตอนการทำงานในการพัฒนา
ขั้นตอนการทำงานทั่วไปของผู้ช่วย AI กับ Buildable:
- เริ่มต้น - เชื่อมต่อกับ Buildable ด้วย API key
- รับบริบท - ทำความเข้าใจโครงสร้างโปรเจกต์และสถานะปัจจุบัน
- ค้นหางาน - รับงานที่มีลำดับความสำคัญถัดไป
- เริ่มงาน - เริ่มทำงานด้วยแนวทางและการประมาณการ
- อัปเดตความคืบหน้า - รายงานความคืบหน้าเป็นประจำพร้อมรายละเอียด
- ถามคำถาม - สร้างการสนทนาสำหรับอุปสรรคหรือการตัดสินใจ
- ทำงานให้เสร็จ - เสร็จสิ้นด้วยบันทึกการเสร็จสมบูรณ์ที่ครอบคลุม
- ทำซ้ำ - ดำเนินการต่อกับงานถัดไป
📊 สถิติการใช้งาน
// Get usage statistics for your AI assistant
const stats = await client.getUsageStats();
console.log(`Tasks completed: ${stats.tasksCompleted}`);
console.log(`Average completion time: ${stats.avgCompletionTime}min`);
console.log(`Success rate: ${stats.successRate}%`);
⚡ การใช้งาน CLI
เมื่อติดตั้งแล้ว คุณสามารถใช้ CLI ได้หลายวิธี:
# Run directly with npx (no installation needed)
npx @bldbl/mcp
# Or install globally and use the bldbl command
npm install -g @bldbl/mcp
bldbl
# For Claude Desktop, use the bldbl command in your config
ตัวแปรสภาพแวดล้อมที่จำเป็น:
BUILDABLE_API_URL- URL API ของ Buildable ของคุณBUILDABLE_API_KEY- API key ของคุณ (ขึ้นต้นด้วย 'bp_')BUILDABLE_PROJECT_ID- ID โปรเจกต์เป้าหมายBUILDABLE_AI_ASSISTANT_ID- ตัวระบุผู้ช่วยเฉพาะ
🧪 การทดสอบ
แพ็คเกจรวมยูทิลิตี้การทดสอบที่ครอบคลุม:
import { createTestClient } from '@bldbl/mcp/test';
// Create a test client with mock responses
const testClient = createTestClient({
mockProject: {
id: 'test-project',
title: 'Test Project'
}
});
// Use in your tests
await testClient.startTask('test-task-id');
🔗 ลิงก์
- 🌐 หน้าแรก: bldbl.dev
- 📚 เอกสารประกอบ: bldbl.dev/docs
- 💬 ชุมชน: Discord
- 🐛 การสนับสนุน: [email protected]
- 📦 แพ็คเกจ NPM: npmjs.com/package/@bldbl/mcp
🏗️ สร้างด้วย
- TypeScript - การพัฒนาแบบ type-safe
- Model Context Protocol (MCP) - การสื่อสารผู้ช่วย AI ที่ได้มาตรฐาน
- Node.js - สภาพแวดล้อมรันไทม์
- REST API - การสื่อสารที่เรียบง่ายและเชื่อถือได้
📄 ใบอนุญาต
ลิขสิทธิ์ © 2025 Buildable Team สงวนลิขสิทธิ์ทั้งหมด
ซอฟต์แวร์นี้เป็นกรรมสิทธิ์และเป็นความลับ ห้ามคัดลอก แจกจ่าย หรือใช้งานโดยไม่ได้รับอนุญาตโดยเด็ดขาด
สร้างด้วย ❤️ โดยทีม Buildable
Buildable เป็นแพลตฟอร์มการพัฒนาเชิงพาณิชย์ที่ขับเคลื่อนด้วย AI เยี่ยมชม bldbl.dev เพื่อเริ่มต้นใช้งาน
🆘 การสนับสนุน
- เอกสารประกอบ: https://bldbl.dev/docs
- อีเมล: [email protected]
- เว็บไซต์: https://bldbl.dev
สร้างด้วย ❤️ โดยทีม BuildPlanner