Couchbase

Couchbase MCP Server

Couchbase MCP Server เป็น MCP Server ที่โฮสต์ด้วยตนเอง ซึ่งช่วยให้ AI agents สามารถเชื่อมต่อและโต้ตอบกับข้อมูลในคลัสเตอร์ Couchbase ไม่ว่าจะโฮสต์บน Capella หรือจัดการด้วยตนเอง โดยมีเครื่องมือครอบคลุมหลายหมวดหมู่ เช่น สุขภาพคลัสเตอร์, โครงสร้างข้อมูล, Key-Value, การสืบค้น, และประสิทธิภาพ — พร้อมการควบคุมความปลอดภัยผ่านโหมดอ่านอย่างเดียวและการปิดใช้งานเครื่องมือแบบละเอียด รองรับทั้ง transport แบบ STDIO และ Streamable HTTP

Couchbase MCP server เผยแพร่เป็นแพ็คเกจ Python Package Index (PyPI) และผ่าน Docker การสนับสนุนระดับองค์กรสำหรับ Couchbase MCP Server มีให้โดยการอนุญาตสิทธิ์ Couchbase AI Data Plane ซึ่งยังให้สิทธิ์ใช้งานและการสนับสนุนระดับองค์กรของ Couchbase Agent Memory และ Couchbase Agent Catalog

สำหรับเอกสารฉบับเต็ม โปรดไปที่ mcp-server.couchbase.com

คุณสมบัติ/เครื่องมือ

เครื่องมือการตั้งค่าและสุขภาพคลัสเตอร์

เครื่องมือการค้นพบโมเดลข้อมูลและโครงสร้าง

เครื่องมือการดำเนินการเอกสาร KV

เครื่องมือการสืบค้นและการสร้างดัชนี

เครื่องมือวิเคราะห์ประสิทธิภาพการสืบค้น

ข้อกำหนดเบื้องต้น

• Python 3.10 หรือสูงกว่า
• คลัสเตอร์ Couchbase ที่กำลังทำงาน วิธีที่ง่ายที่สุดในการเริ่มต้นคือการใช้ ระดับฟรีของ Capella ซึ่งเป็นเวอร์ชันที่จัดการเต็มรูปแบบของเซิร์ฟเวอร์ Couchbase คุณสามารถทำตาม คำแนะนำ เพื่อนำเข้าชุดข้อมูลตัวอย่างหรือนำเข้าข้อมูลของคุณเอง
• ติดตั้ง uv เพื่อรันเซิร์ฟเวอร์
• ติดตั้ง MCP client เช่น Claude Desktop เพื่อเชื่อมต่อเซิร์ฟเวอร์กับ Claude คำแนะนำมีให้สำหรับ Claude Desktop และ Cursor สามารถใช้ MCP clients อื่นได้เช่นกัน

การกำหนดค่า

MCP server สามารถรันได้จากแพ็คเกจ PyPI ที่สร้างไว้ล่วงหน้าหรือจากซอร์สโค้ดโดยใช้ uv

การรันจาก PyPI

เราเผยแพร่ แพ็คเกจ PyPI ที่สร้างไว้ล่วงหน้าสำหรับ MCP server

การกำหนดค่าเซิร์ฟเวอร์โดยใช้แพ็คเกจที่สร้างไว้ล่วงหน้าสำหรับ MCP Clients

การรับรองความถูกต้องพื้นฐาน

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password"
      }
    }
  }
}

หรือ

mTLS

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_CLIENT_CERT_PATH": "/path/to/client-certificate.pem",
        "CB_CLIENT_KEY_PATH": "/path/to/client.key"
      }
    }
  }
}

หมายเหตุ: หากคุณมี MCP servers อื่นที่ใช้งานอยู่ใน client คุณสามารถเพิ่มลงใน mcpServers object ที่มีอยู่ได้

การรันจากซอร์สโค้ด

MCP server สามารถรันจากซอร์สโค้ดโดยใช้ repository นี้

โคลน repository ไปยังเครื่องของคุณ

git clone https://github.com/couchbase/mcp-server-couchbase.git

การกำหนดค่าเซิร์ฟเวอร์โดยใช้ซอร์สโค้ดสำหรับ MCP Clients

นี่คือการกำหนดค่าทั่วไปสำหรับ MCP clients เช่น Claude Desktop, Cursor, Windsurf Editor

{
  "mcpServers": {
    "couchbase": {
      "command": "uv",
      "args": [
        "--directory",
        "path/to/cloned/repo/mcp-server-couchbase/",
        "run",
        "src/mcp_server.py"
      ],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password"
      }
    }
  }
}

หมายเหตุ: path/to/cloned/repo/mcp-server-couchbase/ ควรเป็นเส้นทางไปยัง repository ที่โคลนบนเครื่องของคุณ อย่าลืมเครื่องหมายทับท้าย!

หมายเหตุ: หากคุณมี MCP servers อื่นที่ใช้งานอยู่ใน client คุณสามารถเพิ่มลงใน mcpServers object ที่มีอยู่ได้

การกำหนดค่าเพิ่มเติมสำหรับ MCP Server

เซิร์ฟเวอร์สามารถกำหนดค่าได้โดยใช้ตัวแปรสภาพแวดล้อมหรืออาร์กิวเมนต์บรรทัดคำสั่ง:

การกำหนดค่าโหมดอ่านอย่างเดียว

CB_MCP_READ_ONLY_MODE คือสวิตช์เดียวที่ควบคุมการดำเนินการเขียน:

• เมื่อ true (ค่าเริ่มต้น): การดำเนินการเขียนทั้งหมด (KV, Query, การจัดการสโคป/คอลเลกชัน และการจัดการดัชนี) ถูกปิดใช้งาน เครื่องมือเขียน KV (upsert, insert, replace, delete, sub-document mutate), เครื่องมือเขียนการจัดการสโคป/คอลเลกชัน (create_scope, create_collection, delete_scope, delete_collection) และเครื่องมือเขียนดัชนี (create_index, build_index, drop_index) ไม่ถูกโหลด และจะไม่พร้อมใช้งานสำหรับ LLM และคิวรี SQL++ ที่แก้ไขข้อมูลหรือโครงสร้างจะถูกบล็อก
• เมื่อ false: เครื่องมือเขียน KV, การจัดการสโคป/คอลเลกชัน และดัชนีถูกโหลด และคิวรี SQL++ ที่แก้ไขข้อมูล/โครงสร้างได้รับอนุญาต

นี่คือค่าเริ่มต้นที่ปลอดภัยที่แนะนำเพื่อป้องกันการแก้ไขข้อมูลโดยไม่ตั้งใจจาก LLM

หมายเหตุ: สำหรับการตรวจสอบสิทธิ์ คุณต้องมีชื่อผู้ใช้และรหัสผ่าน หรือเส้นทางใบรับรองไคลเอ็นต์และคีย์ คุณสามารถระบุเส้นทางใบรับรองราก CA ที่จะใช้ตรวจสอบใบรับรองเซิร์ฟเวอร์ได้ หากระบุทั้งเส้นทางใบรับรองไคลเอ็นต์และคีย์ และชื่อผู้ใช้และรหัสผ่าน ใบรับรองไคลเอ็นต์จะถูกใช้สำหรับการตรวจสอบสิทธิ์

การปิดใช้งานเครื่องมือ

คุณสามารถปิดใช้งานเครื่องมือเฉพาะเพื่อป้องกันไม่ให้ถูกโหลดและเปิดเผยต่อไคลเอ็นต์ MCP เครื่องมือที่ปิดใช้งานจะไม่ปรากฏในการค้นพบเครื่องมือและไม่สามารถถูกเรียกใช้โดย LLM

รูปแบบที่รองรับ

รายการที่คั่นด้วยเครื่องหมายจุลภาค:

# Environment variable
CB_MCP_DISABLED_TOOLS="upsert_document_by_id, delete_document_by_id"

# Command line
uvx couchbase-mcp-server --disabled-tools upsert_document_by_id, delete_document_by_id

เส้นทางไฟล์ (หนึ่งชื่อเครื่องมือต่อบรรทัด):

# Environment variable
CB_MCP_DISABLED_TOOLS=disabled_tools.txt

# Command line
uvx couchbase-mcp-server --disabled-tools disabled_tools.txt

รูปแบบไฟล์ (เช่น disabled_tools.txt):

# Write operations
upsert_document_by_id
delete_document_by_id

# Index advisor
get_index_advisor_recommendations

บรรทัดที่ขึ้นต้นด้วย # ถือเป็นความคิดเห็นและจะถูกละเว้น

ตัวอย่างการกำหนดค่าไคลเอ็นต์ MCP

ใช้รายการที่คั่นด้วยเครื่องหมายจุลภาค:

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password",
        "CB_MCP_DISABLED_TOOLS": "upsert_document_by_id,delete_document_by_id"
      }
    }
  }
}

ใช้เส้นทางไฟล์ (แนะนำสำหรับเครื่องมือจำนวนมาก):

{
  "mcpServers": {
    "couchbase": {
      "command": "uvx",
      "args": ["couchbase-mcp-server"],
      "env": {
        "CB_CONNECTION_STRING": "couchbases://connection-string",
        "CB_USERNAME": "username",
        "CB_PASSWORD": "password",
        "CB_MCP_DISABLED_TOOLS": "/path/to/disabled_tools.txt"
      }
    }
  }
}

หมายเหตุด้านความปลอดภัยที่สำคัญ

คำเตือน: การปิดใช้งานเครื่องมือเพียงอย่างเดียวไม่รับประกันว่าการดำเนินการบางอย่างไม่สามารถดำเนินการได้ สิทธิ์ RBAC (Role-Based Access Control) ของผู้ใช้ฐานข้อมูลเป็นตัวควบคุมความปลอดภัยที่เชื่อถือได้

ตัวอย่างเช่น แม้ว่าคุณจะปิดใช้งาน upsert_document_by_id และ delete_document_by_id การแก้ไขข้อมูลยังคงเกิดขึ้นได้ผ่านเครื่องมือ run_sql_plus_plus_query โดยใช้คำสั่ง SQL++ DML (INSERT, UPDATE, DELETE, MERGE) เว้นแต่:

• CB_MCP_READ_ONLY_MODE ถูกตั้งค่าเป็น true (ค่าเริ่มต้น) หรือ
• ผู้ใช้ฐานข้อมูลขาดสิทธิ์ RBAC ที่จำเป็นสำหรับการแก้ไขข้อมูล

แนวทางปฏิบัติที่ดีที่สุด: กำหนดค่าสิทธิ์ RBAC ที่เหมาะสมบนข้อมูลรับรองผู้ใช้ Couchbase ของคุณเสมอเป็นมาตรการรักษาความปลอดภัยหลัก ใช้การปิดใช้งานเครื่องมือเป็นชั้นเพิ่มเติมเพื่อแนะนำพฤติกรรมของ LLM และลดพื้นผิวการโจมตี ไม่ใช่เป็นตัวควบคุมความปลอดภัยเพียงอย่างเดียว

การขอ/ยืนยันสำหรับการเรียกใช้เครื่องมือ

คุณสามารถกำหนดให้มีการยืนยันจากผู้ใช้อย่างชัดเจนสำหรับเครื่องมือเฉพาะก่อนดำเนินการ (เมื่อไคลเอ็นต์ MCP รองรับ elicitation)

CB_MCP_CONFIRMATION_REQUIRED_TOOLS / --confirmation-required-tools รองรับรูปแบบเหล่านี้:

• รายการที่คั่นด้วยเครื่องหมายจุลภาค
• เส้นทางไฟล์ (หนึ่งชื่อเครื่องมือต่อบรรทัด, รองรับความคิดเห็น #)

ตัวอย่าง:

# Environment variable
CB_MCP_CONFIRMATION_REQUIRED_TOOLS="delete_document_by_id,replace_document_by_id"

# Command line
uvx couchbase-mcp-server --confirmation-required-tools delete_document_by_id,replace_document_by_id

เมื่อเครื่องมือที่อยู่ในรายการถูกเรียกใช้:

• หากไคลเอ็นต์รองรับ elicitation ผู้ใช้จะได้รับแจ้งให้ยืนยัน
• หากไคลเอ็นต์ไม่รองรับ elicitation เครื่องมือจะทำงานโดยไม่มีการยืนยันเพื่อความเข้ากันได้ย้อนหลัง

คุณยังสามารถตรวจสอบเวอร์ชันของเซิร์ฟเวอร์ได้โดยใช้:

uvx couchbase-mcp-server --version

การบันทึก

เซิร์ฟเวอร์ MCP บันทึกไปยัง stderr โดยค่าเริ่มต้น การบันทึกถูกกำหนดค่าด้วยตัวแปร CB_MCP_LOG_* ที่ระบุไว้ใน การกำหนดค่าเพิ่มเติม:

• CB_MCP_LOG_LEVEL — จำนวนที่บันทึก: info (ค่าเริ่มต้น) บันทึกเหตุการณ์วงจรชีวิตและการเรียกใช้เครื่องมือ debug เพิ่มรายละเอียดภายในที่ละเอียด และ off ปิดการบันทึกทั้งหมด
• CB_MCP_LOG_SINKS — ตำแหน่งที่บันทึกไป: stderr (ค่าเริ่มต้น), ไฟล์หมุนเวียนตามระดับ (file), หรือทั้งสอง ด้วย file จะเขียนหนึ่งไฟล์ต่อระดับ (เช่น mcp_server.info.log และ mcp_server.error.log) ที่เส้นทางที่ตั้งโดย CB_MCP_LOG_FILE
• ขนาดการหมุนเวียน — CB_MCP_LOG_ROTATION_MAX_SIZE_MB คือขนาดทั่วโลก (เป็น MB) ที่แต่ละไฟล์ตามระดับหมุนเวียน แทนที่แต่ละระดับด้วย CB_MCP_LOG_<LEVEL>_ROTATION_MAX_SIZE_MB (ERROR/WARNING/INFO/DEBUG) ซึ่งเป็น MB เช่นกัน และสืบทอดค่าทั่วโลกเมื่อไม่ได้ตั้งค่า ขนาด 0 (ทั่วโลกหรือต่อระดับ) ไม่ถูกต้องและจะกลับไปใช้ค่าเริ่มต้น (1 MB) พร้อมคำเตือนเมื่อเริ่มต้น CB_MCP_LOG_MAX_BYTES (ไบต์) เลิกใช้งานแล้ว แต่ยังคงรองรับเพื่อความเข้ากันได้ย้อนหลัง ละเว้นเมื่อตั้งค่า CB_MCP_LOG_ROTATION_MAX_SIZE_MB ด้วย และพิมพ์คำเตือนการเลิกใช้งานเมื่อเริ่มต้น
• การเก็บรักษา — CB_MCP_LOG_RETENTION_BACKUP_COUNT กำหนดจำนวนสำเนาสำรองที่หมุนเวียนที่เก็บต่อระดับ (ไม่รวมไฟล์ที่ใช้งานอยู่) ค่าเริ่มต้นของ 1 รักษาพฤติกรรมเดิม แทนที่แต่ละระดับด้วย CB_MCP_LOG_<LEVEL>_RETENTION_BACKUP_COUNT (ERROR/WARNING/INFO/DEBUG) ซึ่งสืบทอดค่าทั่วโลกเมื่อไม่ได้ตั้งค่า ตั้งจำนวนเป็น 0 เพื่อเก็บเฉพาะไฟล์ที่ใช้งานอยู่สำหรับระดับนั้น — ยังคงถูกจำกัดด้วยขนาดการหมุนเวียน (รีเซ็ตเมื่อหมุนเวียนแทนที่จะสำรอง)
• สแนปช็อตการกำหนดค่าเซิร์ฟเวอร์ — เมื่อ sink file ทำงาน บันทึกแบบครั้งเดียว (OS, Python, เวอร์ชัน dependencies, transport, การกำหนดค่าการบันทึกที่แก้ไขแล้ว และการกำหนดค่าเซิร์ฟเวอร์ที่ปกปิด) จะถูกเขียนเป็น JSON ไปยังไฟล์ mcp_server_config.log.json เฉพาะ (ที่มาจากฐาน CB_MCP_LOG_FILE) มันจะถูกเขียนทับทุกครั้งที่เริ่มต้น ดังนั้นฝ่ายสนับสนุนจึงมีการกำหนดค่าปัจจุบันเสมอและไม่เคยเลื่อนออกจากบันทึกหมุนเวียน

# Enable debug logging to both stderr and rotating per-level files
uvx couchbase-mcp-server --log-level=debug --log-sinks=stderr,file

# Keep 30 rotated ERROR backups but only the live DEBUG file
uvx couchbase-mcp-server --log-level=debug --log-sinks=file \
  --log-error-retention-backup-count=30 --log-debug-retention-backup-count=0

สำหรับรายละเอียดเพิ่มเติม ดู เอกสารประกอบ

การกำหนดค่าเฉพาะไคลเอ็นต์

โหมดการขนส่ง Streamable HTTP

MCP Server สามารถรันในโหมดการขนส่ง Streamable HTTP ซึ่งอนุญาตให้ไคลเอนต์หลายตัวเชื่อมต่อกับอินสแตนซ์เซิร์ฟเวอร์เดียวกันผ่าน HTTP ตรวจสอบว่า MCP client ของคุณรองรับการขนส่งแบบ streamable http หรือไม่ก่อนพยายามเชื่อมต่อกับ MCP server ในโหมดนี้

หมายเหตุ: การอนุญาต OAuth 2.1 รองรับบนการขนส่งนี้ ดู OAuth 2.1 Authorization หากไม่ได้กำหนดค่า OAuth ปลายทาง HTTP จะไม่มีการตรวจสอบสิทธิ์

การใช้งาน

โดยค่าเริ่มต้น MCP server จะรันบนพอร์ต 8000 แต่สามารถกำหนดค่าได้โดยใช้ตัวแปรสภาพแวดล้อม --port หรือ CB_MCP_PORT

uvx couchbase-mcp-server \
  --connection-string='<couchbase_connection_string>' \
  --username='<database_username>' \
  --password='<database_password>' \
  --read-only-mode=true \
  --transport=http

เซิร์ฟเวอร์จะพร้อมใช้งานบน http://localhost:8000/mcp ซึ่งสามารถใช้ใน MCP clients ที่รองรับโหมดการขนส่งแบบ streamable http เช่น Cursor

การกำหนดค่า MCP Client

{
  "mcpServers": {
    "couchbase-http": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

โหมดการขนส่ง SSE

มีตัวเลือกในการรัน MCP server ในโหมดการขนส่ง Server-Sent Events (SSE)

หมายเหตุ: โหมด SSE ถูก เลิกใช้งาน โดย MCP เรามีการสนับสนุน Streamable HTTP

SSE: การใช้งาน

โดยค่าเริ่มต้น MCP server จะรันบนพอร์ต 8000 แต่สามารถกำหนดค่าได้โดยใช้ตัวแปรสภาพแวดล้อม --port หรือ CB_MCP_PORT

uvx couchbase-mcp-server \
  --connection-string='<couchbase_connection_string>' \
  --username='<database_username>' \
  --password='<database_password>' \
  --read-only-mode=true \
  --transport=sse

เซิร์ฟเวอร์จะพร้อมใช้งานบน http://localhost:8000/sse ซึ่งสามารถใช้ใน MCP clients ที่รองรับโหมดการขนส่ง SSE เช่น Cursor

SSE: การกำหนดค่า MCP Client

{
  "mcpServers": {
    "couchbase-sse": {
      "url": "http://localhost:8000/sse"
    }
  }
}

การอนุญาต OAuth 2.1

เมื่อรันด้วย --transport=http MCP server สามารถทำหน้าที่เป็น OAuth 2.1 resource server: มันตรวจสอบความถูกต้องของ bearer JWT ที่เข้ามากับ JWKS ของผู้ให้บริการข้อมูลประจำตัวของคุณ มันไม่ขึ้นกับผู้ให้บริการ (ผู้ให้บริการ OAuth 2.1 / OIDC ใด ๆ ที่เผยแพร่ JWKS — Auth0, Okta, Keycloak, AWS Cognito, Microsoft Entra ฯลฯ) และ ไม่ ออกโทเค็นหรือจัดการผู้ใช้ การตั้งค่า OAuth จะถูกละเว้นบน stdio

OAuth ถูกกำหนดค่าด้วยตัวแปร CB_MCP_OAUTH_* ที่ระบุไว้ใน การกำหนดค่าเพิ่มเติม:

• OAuth จะเปิดใช้งานเฉพาะเมื่อตั้งค่าทั้งสาม CB_MCP_OAUTH_JWT_JWKS_URI, CB_MCP_OAUTH_JWT_ISSUER, และ CB_MCP_OAUTH_JWT_AUDIENCE; การตั้งค่าเพียงบางส่วนจะล้มเหลวเมื่อเริ่มต้น
• การตั้งค่า CB_MCP_OAUTH_MCP_BASE_URL เพิ่มเติมจะเผยแพร่ RFC 9728 Protected Resource Metadata เพื่อให้ไคลเอนต์ที่รองรับ PRM สามารถค้นหาเซิร์ฟเวอร์การอนุญาตได้
• การเข้าถึงถูกควบคุมโดยสองขอบเขตที่อ่านจากคำสั่ง scope/scp ของโทเค็น: couchbase-mcp:read (เครื่องมืออ่าน รวมถึง SQL++) และ couchbase-mcp:write (เครื่องมือเขียน: การกลายพันธุ์ KV, การจัดการขอบเขต/คอลเลกชัน และการจัดการดัชนี) การเข้าถึงเต็มรูปแบบต้องใช้ทั้งสอง หาก IdP ของคุณไม่สามารถส่งฉลากมาตรฐานเหล่านั้นได้ ให้แทนที่ด้วย CB_MCP_OAUTH_SCOPE_READ_LABEL / CB_MCP_OAUTH_SCOPE_WRITE_LABEL

uvx couchbase-mcp-server \
  --connection-string='<couchbase_connection_string>' \
  --username='<database_username>' \
  --password='<database_password>' \
  --transport=http \
  --oauth-jwks-uri='https://auth.example.com/.well-known/jwks.json' \
  --oauth-issuer='https://auth.example.com/' \
  --oauth-audience='couchbase-mcp-server' \
  --oauth-mcp-base-url='<public_base_url_of_this_server>'

สำหรับรายละเอียดทั้งหมด ดู เอกสาร

อิมเมจ Docker

MCP server ยังสามารถสร้างและรันเป็นคอนเทนเนอร์ Docker ได้ อิมเมจที่สร้างไว้ล่วงหน้าสามารถพบได้บน DockerHub หรือดึงผ่าน docker pull docker.io/couchbase/mcp-server:latest

หรือเราอยู่ใน Docker MCP Catalog

การสร้างอิมเมจ

docker build -t mcp/couchbase-src .

docker build --build-arg GIT_COMMIT_HASH=$(git rev-parse HEAD) \
  --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') \
  -t mcp/couchbase-src .

# Build with default image name (mcp/couchbase-src)
./build.sh

# Build with custom image name
./build.sh my-custom/image-name

# View git commit hash in image
docker inspect --format='{{index .Config.Labels "org.opencontainers.image.revision"}}' mcp/couchbase-src:latest

# View all metadata labels
docker inspect --format='{{json .Config.Labels}}' mcp/couchbase-src:latest

การรัน

MCP server สามารถรันได้โดยใช้ตัวแปรสภาพแวดล้อมที่ใช้กำหนดค่าการตั้งค่า Couchbase ตัวแปรสภาพแวดล้อมเหมือนกับที่อธิบายไว้ใน ส่วนการกำหนดค่าเพิ่มเติม

คอนเทนเนอร์ Docker แบบอิสระ

docker run --rm -i \
  -e CB_CONNECTION_STRING='<couchbase_connection_string>' \
  -e CB_USERNAME='<database_user>' \
  -e CB_PASSWORD='<database_password>' \
  -e CB_MCP_TRANSPORT='<http|sse|stdio>' \
  -e CB_MCP_READ_ONLY_MODE='<true|false>' \
  -e CB_MCP_CONFIRMATION_REQUIRED_TOOLS='delete_document_by_id' \
  -e CB_MCP_PORT=9001 \
  -e CB_MCP_HOST=0.0.0.0 \
  -p 9001:9001 \
  mcp/couchbase-src

ตัวแปรสภาพแวดล้อม CB_MCP_PORT และ CB_MCP_HOST ใช้ได้เฉพาะในกรณีของโหมดการขนส่ง HTTP เช่น http และ sse

Docker: การกำหนดค่า MCP Client

อิมเมจ Docker สามารถใช้ในโหมดการขนส่ง stdio ด้วยการกำหนดค่าต่อไปนี้

{
  "mcpServers": {
    "couchbase-mcp-docker": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "CB_CONNECTION_STRING=<couchbase_connection_string>",
        "-e",
        "CB_USERNAME=<database_user>",
        "-e",
        "CB_PASSWORD=<database_password>",
        "mcp/couchbase-src"
      ]
    }
  }
}

หมายเหตุ

• ค่า couchbase_connection_string ขึ้นอยู่กับว่าเซิร์ฟเวอร์ Couchbase กำลังรันบนเครื่องโฮสต์เดียวกัน ในคอนเทนเนอร์ Docker อื่น หรือบนโฮสต์ระยะไกล หากเซิร์ฟเวอร์ Couchbase ของคุณรันบนเครื่องโฮสต์ของคุณ สตริงการเชื่อมต่อของคุณอาจอยู่ในรูปแบบ couchbase://host.docker.internal สำหรับรายละเอียด โปรดดู เอกสาร docker
• คุณสามารถระบุเครือข่ายของคอนเทนเนอร์ได้โดยใช้ตัวเลือก --network=<your_network> เครือข่ายที่คุณเลือกขึ้นอยู่กับสภาพแวดล้อมของคุณ ค่าเริ่มต้นคือ bridge สำหรับรายละเอียด โปรดดู ไดรเวอร์เครือข่ายใน docker

ความเสี่ยงที่เกี่ยวข้องกับ LLM

• การใช้โมเดลภาษาขนาดใหญ่และเทคโนโลยีที่คล้ายคลึงกันมีความเสี่ยง รวมถึงความเป็นไปได้ของผลลัพธ์ที่ไม่ถูกต้องหรือเป็นอันตราย
• Couchbase ไม่ตรวจสอบหรือประเมินคุณภาพหรือความถูกต้องของผลลัพธ์ดังกล่าว และผลลัพธ์ดังกล่าวอาจไม่สะท้อนมุมมองของ Couchbase
• คุณรับผิดชอบแต่เพียงผู้เดียวในการตัดสินใจว่าจะใช้โมเดลภาษาขนาดใหญ่และเทคโนโลยีที่เกี่ยวข้องหรือไม่ และปฏิบัติตามข้อกำหนดใบอนุญาต ข้อกำหนดการใช้งาน และนโยบายขององค์กรของคุณที่ควบคุมการใช้งานดังกล่าว

การเก็บข้อมูลการใช้งาน

ผลิตภัณฑ์นี้เก็บข้อมูลการใช้งานและประสิทธิภาพโดยอัตโนมัติ (เช่น ชื่อผลิตภัณฑ์และเวอร์ชัน) และข้อมูลเบราว์เซอร์ (เช่น ที่อยู่ IP) (รวมเรียกว่า "ข้อมูลการใช้งาน") Couchbase ใช้ข้อมูลการใช้งาน พร้อมกับข้อมูลอื่น ๆ ที่คุณอาจให้กับ Couchbase (เช่น ชื่อผู้ใช้หรือที่อยู่อีเมลของคุณ) เพื่อพัฒนาและปรับปรุงผลิตภัณฑ์ของเรา รวมถึงแจ้งโปรแกรมการขายและการตลาดของเรา เราไม่เข้าถึงหรือเก็บข้อมูลใด ๆ ที่คุณจัดเก็บในผลิตภัณฑ์ Couchbase เราใช้ข้อมูลการใช้งานเพื่อทำความเข้าใจรูปแบบการใช้งานโดยรวมและทำให้ผลิตภัณฑ์ของเรามีประโยชน์ต่อคุณมากขึ้น สำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิธีที่ Couchbase เก็บรวบรวม ปกป้อง และประมวลผลข้อมูล โปรดดูนโยบายความเป็นส่วนตัวของ Couchbase ที่ https://www.couchbase.com/privacy-policy.

เคล็ดลับการแก้ไขปัญหา

• ตรวจสอบให้แน่ใจว่าเส้นทางไปยังที่เก็บ MCP server ของคุณถูกต้องในการกำหนดค่า หากรันจากซอร์ส
• ตรวจสอบว่าสตริงการเชื่อมต่อ Couchbase, ชื่อผู้ใช้ฐานข้อมูล, รหัสผ่าน หรือเส้นทางไปยังใบรับรองถูกต้อง
• หากใช้ Couchbase Capella ตรวจสอบให้แน่ใจว่าคลัสเตอร์สามารถ เข้าถึงได้ จากเครื่องที่รัน MCP server อยู่
• ตรวจสอบว่าผู้ใช้ฐานข้อมูลมีสิทธิ์ที่เหมาะสมในการเข้าถึงบัคเก็ตอย่างน้อยหนึ่งบัคเก็ต
• ยืนยันว่า uv package manager ได้รับการติดตั้งอย่างถูกต้องและสามารถเข้าถึงได้ คุณอาจต้องระบุเส้นทางแบบสัมบูรณ์ไปยัง uv/uvx ในฟิลด์ command ในการกำหนดค่า
• ตรวจสอบบันทึก (logs) สำหรับข้อผิดพลาดหรือคำเตือนที่อาจบ่งบอกถึงปัญหากับ MCP server ตำแหน่งของบันทึกขึ้นอยู่กับ MCP client ของคุณ
• หากคุณพบปัญหาการรัน MCP server จากซอร์สหลังจากการอัปเดตที่เก็บ MCP server ในเครื่องของคุณ ให้ลองรัน uv sync เพื่ออัปเดต dependencies

การทดสอบการรวมระบบ

เรามีการทดสอบการรวมระบบ MCP ระดับสูงเพื่อตรวจสอบว่าเซิร์ฟเวอร์เปิดเผยเครื่องมือที่คาดหวังและสามารถเรียกใช้กับคลัสเตอร์ Couchbase สาธิตได้

1. ส่งออกข้อมูลประจำตัวของคลัสเตอร์สาธิต:
   • CB_CONNECTION_STRING
   • CB_USERNAME
   • CB_PASSWORD
   • ไม่บังคับ: CB_MCP_TEST_BUCKET (บัคเก็ตที่จะใช้ตรวจสอบระหว่างการทดสอบ)
2. รันการทดสอบ:

uv run pytest tests/ -v

👩‍💻 การมีส่วนร่วม

เรายินดีต้อนรับการมีส่วนร่วมจากชุมชน! ไม่ว่าคุณต้องการแก้ไขบั๊ก เพิ่มฟีเจอร์ หรือปรับปรุงเอกสาร ความช่วยเหลือของคุณเป็นที่ชื่นชม

หากคุณต้องการความช่วยเหลือ พบข้อบกพร่อง หรือต้องการมีส่วนร่วมในการปรับปรุง สถานที่ที่ดีที่สุดคือที่นี่ — โดย การเปิด issue บน GitHub

สำหรับนักพัฒนา

หากคุณสนใจที่จะมีส่วนร่วมในโค้ดหรือตั้งค่าสภาพแวดล้อมการพัฒนา:

📖 ดู CONTRIBUTING.md สำหรับคำแนะนำการตั้งค่าสำหรับนักพัฒนาอย่างครอบคลุม รวมถึง:

• การตั้งค่าสภาพแวดล้อมการพัฒนาด้วย uv
• การตรวจสอบและจัดรูปแบบโค้ดด้วย Ruff
• การติดตั้ง pre-commit hooks
• ภาพรวมโครงสร้างโปรเจกต์
• ขั้นตอนการพัฒนาและแนวปฏิบัติ

เริ่มต้นอย่างรวดเร็วสำหรับผู้มีส่วนร่วม

# Clone and setup
git clone https://github.com/couchbase/mcp-server-couchbase.git
cd mcp-server-couchbase

# Install with development dependencies
uv sync --extra dev

# Install pre-commit hooks
uv run pre-commit install

# Run linting
./scripts/lint.sh

📢 นโยบายการสนับสนุน

เราขอขอบคุณในความสนใจของคุณต่อโปรเจกต์นี้! โปรเจกต์นี้เป็น การดูแลโดยชุมชน Couchbase ซึ่งหมายความว่า ไม่ได้รับการสนับสนุนอย่างเป็นทางการ จากทีมสนับสนุนของเรา อย่างไรก็ตาม วิศวกรของเรากำลังติดตามและดูแล repo นี้อย่างแข็งขัน และจะพยายามแก้ไขปัญหาตามความสามารถที่ดีที่สุด

พอร์ทัลสนับสนุนของเราไม่สามารถช่วยเหลือเกี่ยวกับคำขอที่เกี่ยวข้องกับโปรเจกต์นี้ได้ ดังนั้นเราจึงขอให้คำถามทั้งหมดอยู่ใน GitHub

ความร่วมมือของคุณช่วยให้เราก้าวไปด้วยกัน — ขอบคุณ!