Couchbase
आधिकारिकCouchbase क्लस्टर में संग्रहीत डेटा के साथ प्राकृतिक भाषा का उपयोग करके इंटरैक्ट करें।
Couchbase MCP के साथ आप क्या कर सकते हैं?
- क्लस्टर डेटा एक्सप्लोर करें — बकेट, स्कोप और कलेक्शन सूचीबद्ध करें, फिर
ordersजैसे कलेक्शन का स्कीमा अनुमानित करें। - SQL++ क्वेरी चलाएँ — बकेट और स्कोप पर केवल-पढ़ने वाली SQL++ क्वेरी निष्पादित करें और क्वेरी प्लान समझाएँ।
- दस्तावेज़ों का निरीक्षण करें — ID से कोई दस्तावेज़ प्राप्त करें या पूरा दस्तावेज़ लोड किए बिना विशिष्ट सबडॉक्यूमेंट पथ पढ़ें।
- क्लस्टर की स्थिति जाँचें — क्लस्टर की स्थिति, चल रही सेवाओं और कनेक्शन डायग्नोस्टिक्स की रिपोर्ट दें।
- क्वेरी प्रदर्शन का विश्लेषण करें — सबसे लंबे समय तक चलने वाली, सबसे अधिक बार चलने वाली या नॉन-कवरिंग-इंडेक्स वाली क्वेरी खोजें।
- खोज और वेक्टर क्वेरी — कॉन्फ़िगर किए गए इंडेक्स पर फ़ुल-टेक्स्ट खोज और वेक्टर समानता क्वेरी चलाएँ।
दस्तावेज़
Couchbase MCP Server
Couchbase MCP Server एक स्व-होस्ट किया गया MCP Server है, जो AI एजेंटों को Couchbase Servers (चाहे वे Capella पर होस्ट किए गए हों या स्वयं प्रबंधित हों) या Operational Insights Enterprise में मौजूद डेटा से जुड़ने और उसके साथ इंटरैक्ट करने की सुविधा देता है। यह Cluster Health, Data Schema, Query और अन्य श्रेणियों में टूल उपलब्ध कराता है — साथ ही read-only mode और टूल को बारीकी से अक्षम करने के ज़रिए सुरक्षा नियंत्रण भी देता है। यह OAuth क्षमताओं के साथ STDIO और Streamable HTTP, दोनों ट्रांसपोर्ट का समर्थन करता है।
Couchbase MCP Server को Python Package Index (PyPI) पैकेज के रूप में और Docker के ज़रिए वितरित किया जाता है। Couchbase MCP Server के लिए एंटरप्राइज़ सहायता, Couchbase AI Data Plane का लाइसेंस लेकर उपलब्ध है। यह लाइसेंस Couchbase Agent Memory और Couchbase Agent Catalog के उपयोग तथा एंटरप्राइज़ सहायता का अधिकार भी देता है।
पूरा दस्तावेज़: docs.couchbase.com/mcp-server
विषय-सूची
- Couchbase MCP Server क्यों
- सर्वर चुनना
- Operational Server
- Operational Insights Server
- सामान्य कॉन्फ़िगरेशन
- क्लाइंट सेटअप
- Docker
- समस्या निवारण
- अक्सर पूछे जाने वाले प्रश्न
- योगदान
- उपयोग डेटा, LLM जोखिम और सहायता नीति
Couchbase MCP Server क्यों
- डिफ़ॉल्ट रूप से सुरक्षित — जब तक आप
CB_MCP_READ_ONLY_MODE=falseसेट नहीं करते, write टूल लोड नहीं होते और डेटा में बदलाव करने वाली क्वेरी ब्लॉक रहती हैं; अलग-अलग टूल को अक्षम भी किया जा सकता है या उपयोगकर्ता की पुष्टि आवश्यक बनाई जा सकती है। - Couchbase Server और Operational Insights — operational server समान कॉन्फ़िगरेशन के साथ Couchbase Capella या स्वयं प्रबंधित Couchbase Server क्लस्टर से जुड़ता है; Operational Insights server स्वयं प्रबंधित Operational Insights क्लस्टर से जुड़ता है।
- RBAC-जागरूक — टूल नियंत्रण LLM को दिशा देते हैं; Couchbase उपयोगकर्ता का role-based access control ही सुरक्षा की प्रामाणिक सीमा बना रहता है।
- प्रोडक्शन ट्रांसपोर्ट — स्थानीय डेस्कटॉप क्लाइंट के लिए STDIO, या वैकल्पिक OAuth 2.1 (कोई भी JWKS प्रकाशित करने वाला IdP: Auth0, Okta, Keycloak, Entra, Cognito, …), हेल्थ चेक और साझा डिप्लॉयमेंट के लिए ऑडिट लॉगिंग के साथ Streamable HTTP। अधिक CPU कोर का उपयोग करने के लिए operational server एकाधिक workers भी चला सकता है।
- कोई भी MCP क्लाइंट — Claude Desktop, Cursor, Windsurf, VS Code और JetBrains AI Assistant/Junie के साथ परीक्षण किया गया है।
कनेक्ट होने के बाद, आप इस तरह के सवाल पूछ सकते हैं:
- "मेरे पास कौन-से buckets, scopes और collections हैं, और
orderscollection का schema क्या है?" - "
usersमें ऐसे 10 सबसे नए दस्तावेज़ खोजें जहाँstatus = 'active'।" - "पिछले घंटे की 5 सबसे धीमी क्वेरी कौन-सी हैं, और क्या उनमें से किसी में covering index नहीं है?"
- "क्या यह क्लस्टर स्वस्थ है, और कौन-सी सेवाएँ चल रही हैं?"
- "इन फ़ील्ड के साथ
productsमें नया दस्तावेज़ डालें: …" (इसके लिएCB_MCP_READ_ONLY_MODE=falseआवश्यक है)
सर्वर चुनना
इस पैकेज में दो MCP सर्वर शामिल हैं। हर सर्वर अपने अलग subcommand से शुरू होता है, अलग प्रकार के क्लस्टर से जुड़ता है और उसके अपने टूल हैं। अपने क्लस्टर के अनुरूप सर्वर चुनें, सेटअप और टूल के लिए उसका अनुभाग देखें, फिर दोनों में साझा सेटिंग के लिए सामान्य कॉन्फ़िगरेशन देखें। दोनों का उपयोग करने के लिए, अपने MCP क्लाइंट में हर सर्वर को अलग-अलग रजिस्टर करें।
| Operational server | Operational Insights server | |
|---|---|---|
| इसके साथ उपयोग करें | Couchbase क्लस्टर (Capella या स्वयं प्रबंधित) | स्वयं प्रबंधित Operational Insights क्लस्टर (Capella पर उपलब्ध नहीं) |
| Subcommand | operational (डिफ़ॉल्ट) | operational-insights |
| Connection string | couchbase:// / couchbases:// | HTTP(S) URL, जैसे http://localhost:8095 |
| Credential variables | CB_CONNECTION_STRING, CB_USERNAME, … | CB_OPERATIONAL_INSIGHTS_CONNECTION_STRING, CB_OPERATIONAL_INSIGHTS_USERNAME, … |
| टूल | 52 — क्लस्टर हेल्थ, schema, KV, SQL++, indexes, full-text और vector search, query performance | 13 — schema, SQL++, (sync और async), indexes, exports |
| डिफ़ॉल्ट HTTP पोर्ट | 8000 | 8001 |
| डिफ़ॉल्ट लॉग फ़ाइल | mcp_server.log | mcp_server_operational_insights.log |
आज operational server के लिए subcommand वैकल्पिक है — केवल
couchbase-mcp-serverचलाने से यह शुरू हो जाता है — लेकिन इसे स्पष्ट रूप से लिखने से आपका कॉन्फ़िगरेशन अस्पष्ट नहीं रहता। विकल्प subcommand के बाद दें:couchbase-mcp-server operational --transport=http। इंस्टॉल किए गए संस्करण की जाँचuvx couchbase-mcp-server --versionसे करें।
Operational Server
operational server, couchbase Python SDK का उपयोग करके, Capella या स्वयं प्रबंधित Couchbase Server पर मौजूद Couchbase क्लस्टर से जुड़ता है।
Operational Quick Start
आपको चल रहा Couchbase क्लस्टर चाहिए — इसे पाने का सबसे तेज़ तरीका Capella free tier है (आप नमूना डेटासेट आयात कर सकते हैं) — और एक MCP client। अपने क्लाइंट में इनमें से एक कॉन्फ़िगरेशन जोड़ें (हर क्लाइंट में यह कहाँ रखा जाता है, इसके लिए Client Setup देखें)। यदि क्लाइंट में पहले से अन्य सर्वर हैं, तो मौजूदा mcpServers ऑब्जेक्ट में couchbase जोड़ें।
PyPI से uvx के साथ (uv और Python 3.11+ आवश्यक):
{
"mcpServers": {
"couchbase": {
"command": "uvx",
"args": ["couchbase-mcp-server", "operational"],
"env": {
"CB_CONNECTION_STRING": "couchbases://connection-string",
"CB_USERNAME": "username",
"CB_PASSWORD": "password"
}
}
}
}
Docker के साथ (केवल Docker आवश्यक):
{
"mcpServers": {
"couchbase": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "CB_CONNECTION_STRING=couchbases://connection-string",
"-e", "CB_USERNAME=username",
"-e", "CB_PASSWORD=password",
"couchbase/mcp-server:latest", "operational"
]
}
}
}
सोर्स से
git clone https://github.com/couchbase/mcp-server-couchbase.git
{
"mcpServers": {
"couchbase": {
"command": "uv",
"args": [
"--directory", "path/to/cloned/repo/mcp-server-couchbase/",
"run", "src/mcp_server.py", "operational"
],
"env": {
"CB_CONNECTION_STRING": "couchbases://connection-string",
"CB_USERNAME": "username",
"CB_PASSWORD": "password"
}
}
}
}
path/to/cloned/repo/mcp-server-couchbase/ आपके क्लोन का पाथ है — अंत में लगा स्लैश बनाए रखें। अपडेट खींचने के बाद, निर्भरताएँ अपडेट करने के लिए uv sync चलाएँ।
Operational Connection and Authentication
या तो username और password का उपयोग करें या client certificate (mTLS) का। यदि दोनों सेट हों, तो certificate का उपयोग किया जाता है।
| Environment Variable | CLI Argument | विवरण |
|---|---|---|
CB_CONNECTION_STRING | --connection-string | क्लस्टर का connection string। आवश्यक |
CB_USERNAME / CB_PASSWORD | --username / --password | Basic authentication |
CB_CLIENT_CERT_PATH / CB_CLIENT_KEY_PATH | --client-cert-path / --client-key-path | mTLS authentication |
CB_CA_CERT_PATH | --ca-cert-path | स्वयं-हस्ताक्षरित/अविश्वसनीय server certificate के लिए root certificate (Capella के लिए आवश्यक नहीं) |
mTLS उदाहरण
{
"mcpServers": {
"couchbase": {
"command": "uvx",
"args": ["couchbase-mcp-server", "operational"],
"env": {
"CB_CONNECTION_STRING": "couchbases://connection-string",
"CB_CLIENT_CERT_PATH": "/path/to/client-certificate.pem",
"CB_CLIENT_KEY_PATH": "/path/to/client.key"
}
}
}
}
Operational Tools
जब read-only mode चालू हो, जो कि डिफ़ॉल्ट है, तो write टूल (✏️ से चिह्नित) लोड नहीं होते। 🖥️ से चिह्नित टूल केवल स्वयं प्रबंधित क्लस्टर के लिए हैं — वे ऐसे admin REST endpoints का उपयोग करते हैं जिन्हें Capella उपलब्ध नहीं कराता, या (discover_tool_input_values) केवल उस टूल के लिए संदर्भ डेटा देते हैं जो ऐसा करता है — इसलिए इनके लिए स्वयं प्रबंधित Couchbase Server 7.6+ आवश्यक है और Capella कनेक्शन पर ये रजिस्टर नहीं होते।
क्लस्टर सेटअप और हेल्थ
| टूल | विवरण |
|---|---|
get_server_configuration_status | क्लस्टर से जुड़े बिना सर्वर की स्थिति और कॉन्फ़िगरेशन: read-only mode, अक्षम/पुष्टि-आवश्यक टूल, OAuth, लॉगिंग और ऑडिट काउंटर |
test_cluster_connection | क्लस्टर से कनेक्ट करके क्लस्टर क्रेडेंशियल जाँचें |
get_cluster_health_and_services | क्लस्टर हेल्थ और चल रही सेवाएँ, वैकल्पिक रूप से service_types के ज़रिए फ़िल्टर की जा सकती हैं |
get_client_connectivity_report | SDK के कैश किए गए कनेक्शन डायग्नोस्टिक्स, सक्रिय नेटवर्क जाँच के बिना |
get_cluster_metrics 🖥️ | ऐतिहासिक समयावधि में क्लस्टर आँकड़े (stats-range endpoint) |
get_cluster_tasks 🖥️ | इस समय चल रहे कार्य — rebalance, compaction, XDCR, index build। इसके लिए ro_admin आवश्यक है |
get_cluster_health_snapshot 🖥️ | हर नोड का हेल्थ: सेवा टोपोलॉजी, सदस्यता, orchestrator और हेल्थ का समग्र आकलन। इसके लिए ro_admin आवश्यक है |
get_bucket_config 🖥️ | किसी एक bucket (या सभी buckets) का कॉन्फ़िगरेशन और लाइव स्थिति — quotas, eviction, replicas, durability, storage, compaction। इसके लिए ro_admin आवश्यक है |
get_cluster_system_events 🖥️ | सिस्टम इवेंट लॉग (कॉन्फ़िगरेशन बदलाव, failovers, rebalances, restarts), since_time के साथ समयावधि के अनुसार। इसके लिए Full Admin या Cluster Admin आवश्यक है |
discover_tool_input_values 🖥️ | अन्य टूल के लिए आवश्यक सटीक इनपुट मान देखें (जैसे get_cluster_metrics के लिए हर metric name)। ऑफ़लाइन काम करता है |
डेटा मॉडल और schema की खोज
| टूल | विवरण |
|---|---|
get_buckets_in_cluster | क्लस्टर के सभी buckets की सूची दें |
get_scopes_in_bucket | किसी bucket के सभी scopes की सूची दें |
get_collections_in_scope | किसी scope के सभी collections की सूची दें (Query service आवश्यक) |
get_scopes_and_collections_in_bucket | किसी bucket के सभी scopes और collections की सूची दें |
get_schema_for_collection | किसी collection की संरचना का अनुमान लगाएँ |
create_scope ✏️ | किसी bucket में scope बनाएँ (Server 7.6+ और Capella) |
create_collection ✏️ | मौजूदा scope में collection बनाएँ (Server 7.6+ और Capella) |
delete_scope ✏️ | scope और उसके सभी collections हटाएँ — स्थायी रूप से |
delete_collection ✏️ | collection और उसके सभी दस्तावेज़ हटाएँ — स्थायी रूप से |
दस्तावेज़ (KV) ऑपरेशन
| टूल | विवरण |
|---|---|
get_document_by_id | ID के आधार पर दस्तावेज़ प्राप्त करें |
lookup_subdocument | पूरा दस्तावेज़ प्राप्त किए बिना विशिष्ट paths, मौजूदगी की जाँच या गिनती करें |
upsert_document_by_id ✏️ | ID के आधार पर दस्तावेज़ upsert करें |
insert_document_by_id ✏️ | नया दस्तावेज़ डालें (यदि पहले से मौजूद हो तो विफल होता है) |
replace_document_by_id ✏️ | मौजूदा दस्तावेज़ बदलें (यदि मौजूद न हो तो विफल होता है) |
delete_document_by_id ✏️ | ID के आधार पर दस्तावेज़ हटाएँ |
mutate_subdocument ✏️ | मौजूदा दस्तावेज़ में paths संशोधित करें (upsert, insert, replace, remove, array ops, counters) |
Query और indexing
| टूल | विवरण |
|---|---|
run_sql_plus_plus_query | किसी bucket और scope तक सीमित SQL++ क्वेरी चलाएँ — collection names सीधे उपयोग करें (SELECT * FROM users)। read-only mode में डेटा बदलने वाले statements ब्लॉक रहते हैं |
explain_sql_plus_plus_query | EXPLAIN plan बनाएँ और उसका मूल्यांकन करें: metadata, निकाला गया plan और निष्कर्ष |
get_index_advisor_recommendations | SQL++ क्वेरी के लिए Index Advisor की सिफ़ारिशें |
list_indexes | परिभाषाओं सहित indexes की सूची दें; bucket/scope/collection/name के आधार पर फ़िल्टर किया जा सकता है; vector indexes को चिह्नित करता है (is_vector, vector_type) |
get_index_stats 🖥️ | हर नोड पर प्रति-index आकार, fragmentation, scan traffic और lag — दबाव और अनुपयोगी indexes का पता लगाता है |
create_query_index ✏️ | scalar, Hyperscale vector या Composite vector GSI index बनाएँ (index_type)। डिफ़ॉल्ट रूप से deferred रहता है — इसके बाद build_index चलाएँ |
create_index ✏️ | Deprecated — create_query_index का उपयोग करें। 2.0 में हटाया गया |
build_index ✏️ | किसी collection के सभी deferred indexes बनाएँ |
drop_index ✏️ | GSI index (scalar या vector) हटाएँ |
Full-text search (FTS)
इसके लिए Couchbase Server 7.6+ और Search service आवश्यक हैं। Scope-स्तर और cluster-स्तर (legacy) दोनों indexes समर्थित हैं: scope-स्तर के लिए bucket_name और scope_name साथ में दें, या दोनों छोड़ दें।
| Tool | विवरण |
|---|---|
list_search_indexes | Search इंडेक्स सूचीबद्ध करें — क्लस्टर-स्तर पर, प्रति बकेट या प्रति स्कोप |
get_search_index_definition | एक Search इंडेक्स की पूरी परिभाषा (मैपिंग, एनालाइज़र, प्लान पैरामीटर) |
run_search | उसके रॉ JSON बॉडी से कोई भी गैर-वेक्टर FTS क्वेरी चलाएँ; explain=true निष्पादन योजना लौटाता है |
upsert_search_index ✏️ | वेक्टर फ़ील्ड मैपिंग सहित Search इंडेक्स बनाएँ या अपडेट करें। अपडेट से पूरा रीबिल्ड शुरू होता है — समवर्ती बदलावों को अधिलेखित होने से बचाने के लिए मौजूदा uuid पास करें |
drop_search_index ✏️ | Search इंडेक्स हटाएँ — स्थायी रूप से |
वेक्टर खोज
दोनों टूल Embedding Providers के अंतर्गत कॉन्फ़िगर किए गए मॉडल से सादा क्वेरी टेक्स्ट एम्बेड करते हैं। स्व-प्रबंधित Couchbase Server और Capella पर उपलब्ध।
| Tool | विवरण |
|---|---|
run_vector_query | APPROX_VECTOR_DISTANCE() के ज़रिए GSI वेक्टर इंडेक्स (Server 8.0+) पर समानता खोज। इंडेक्स अपने-आप चुना जाता है; SQL++ where प्रीफ़िल्टर और Hyperscale ट्यूनिंग (num_probes, rerank, top_n_scan) का समर्थन करता है। पूरे दस्तावेज़ लौटाता है |
run_vector_search | नामित इंडेक्स पर Search-service वेक्टर खोज (Server 7.6+)। scalar_query इसे हाइब्रिड बनाता है; prefilter पहले उम्मीदवारों का दायरा सीमित करता है। हर हिट के लिए इंडेक्स में संग्रहीत फ़ील्ड लौटाता है |
क्वेरी प्रदर्शन विश्लेषण
| Tool | विवरण |
|---|---|
get_longest_running_queries | औसत सेवा समय के अनुसार सबसे लंबे समय तक चलने वाली क्वेरी |
get_most_frequent_queries | सबसे अधिक बार निष्पादित क्वेरी |
get_queries_with_largest_response_sizes | सबसे बड़े रिस्पॉन्स आकार वाली क्वेरी |
get_queries_with_large_result_count | सबसे अधिक परिणामों वाली क्वेरी |
get_queries_using_primary_index | प्राथमिक इंडेक्स का उपयोग करने वाली क्वेरी |
get_queries_not_using_covering_index | कवरिंग इंडेक्स का उपयोग न करने वाली क्वेरी |
get_queries_not_selective | ऐसी क्वेरी जिनके स्कैन — सेकेंडरी इंडेक्स, प्राथमिक इंडेक्स या क्रमिक स्कैन — अंतिम परिणाम की तुलना में कहीं अधिक दस्तावेज़ लौटाते हैं |
Query सेवा की स्थिति 🖥️
ये हर क्वेरी नोड पर Query सेवा के अपने एडमिन REST API को कॉल करते हैं।
| Tool | विवरण |
|---|---|
get_cluster_query_vitals | Query इंजन की स्थिति: अनुरोध दर, सक्रिय/कतारबद्ध अनुरोध, मेमोरी, GC, अपटाइम। इसके लिए ro_admin आवश्यक है |
get_active_queries | सभी क्वेरी नोड पर अभी निष्पादित हो रही क्वेरी। इसके लिए ro_admin आवश्यक है |
delete_active_query ✏️ | अनुरोध ID से चल रही क्वेरी रद्द करें। इसके लिए Full Admin या Cluster Admin आवश्यक है |
Capella पर अपने-आप अक्षम होने वाले टूल
🖥️ टूल एडमिन REST एंडपॉइंट के ज़रिए Couchbase तक पहुँचते हैं, जिन्हें Capella उपलब्ध नहीं कराता (एक अपवाद, discover_tool_input_values, रोक दिया जाता है क्योंकि यह केवल ऐसे टूल को सेवा देता है जिन्हें इनकी आवश्यकता होती है)। जब CB_CONNECTION_STRING का हर होस्ट .cloud.couchbase.com पर समाप्त होता है, तो सर्वर इन्हें रजिस्टर नहीं करता और इन्हें आपके अपने अक्षम टूल के साथ get_server_configuration_status और स्टार्टअप लॉग में रिपोर्ट करता है। get_cluster_health_and_services और get_client_connectivity_report जैसे SDK-आधारित टूल उपलब्ध रहते हैं।
| Tool | आवश्यक एंडपॉइंट |
|---|---|
get_cluster_metrics | Management REST (/pools/default/stats/range) |
get_cluster_tasks | Management REST (/pools/default/tasks) |
get_bucket_config | Management REST (/pools/default/buckets[/<name>]) |
get_cluster_health_snapshot | Management REST, साथ ही प्रति-नोड एंडपॉइंट |
get_cluster_system_events | Management REST (/events) |
get_index_stats | Index Service REST (हर indexer का /api/v1/stats) |
get_cluster_query_vitals | Query service REST (/admin/vitals) |
get_active_queries | Query service REST (/admin/active_requests) |
delete_active_query | Query service REST (DELETE /admin/active_requests/{id}) |
discover_tool_input_values | कोई नहीं (ऑफ़लाइन काम करता है), लेकिन यह केवल get_cluster_metrics को सेवा देता है, जो Capella में उपलब्ध नहीं है |
Embedding Providers
run_vector_query और run_vector_search, CB_MCP_EMBEDDING_MODEL_PROVIDER में सेट किए गए प्रोवाइडर से क्वेरी टेक्स्ट एम्बेड करते हैं। यह वैकल्पिक है: इसके बिना सर्वर सामान्य रूप से शुरू होता है और दोनों टूल रजिस्टर रहते हैं, लेकिन उन्हें कॉल करने पर यह बताने वाली त्रुटि मिलती है कि क्या सेट करना है।
CB_MCP_EMBEDDING_MODEL_PROVIDER | आवश्यक | वैकल्पिक | टिप्पणियाँ |
|---|---|---|---|
capella | CB_MCP_EMBEDDING_MODEL_API_KEY, CB_MCP_EMBEDDING_MODEL, CB_MCP_EMBEDDING_MODEL_ENDPOINT | — | Capella Model Service। CB_MCP_EMBEDDING_MODEL_ENDPOINT आपके डिप्लॉयमेंट का अपना URL है (उदा. https://<id>.ai.couchbase.com), जो Capella के AI Data Plane > Models में मिलता है |
openai | CB_MCP_EMBEDDING_MODEL_API_KEY, CB_MCP_EMBEDDING_MODEL | CB_MCP_EMBEDDING_MODEL_ENDPOINT | OpenAI-संगत स्थानीय सर्वर (Ollama, vLLM, LM Studio) का उपयोग करने के लिए एंडपॉइंट सेट करें |
cohere | CB_MCP_EMBEDDING_MODEL_API_KEY, CB_MCP_EMBEDDING_MODEL | CB_MCP_EMBEDDING_MODEL_ENDPOINT | |
voyage | CB_MCP_EMBEDDING_MODEL_API_KEY, CB_MCP_EMBEDDING_MODEL | CB_MCP_EMBEDDING_MODEL_ENDPOINT | |
bedrock | CB_MCP_EMBEDDING_MODEL | CB_MCP_EMBEDDING_MODEL_AWS_ACCESS_KEY_ID, CB_MCP_EMBEDDING_MODEL_AWS_SECRET_ACCESS_KEY, CB_MCP_EMBEDDING_MODEL_AWS_REGION | Amazon Titan embedding मॉडल (उदा. amazon.titan-embed-text-v2:0) — प्रोवाइडर Titan का inputText अनुरोध फ़ॉर्मैट भेजता है, इसलिए Cohere Embed जैसे अन्य Bedrock embedding मॉडल अभी समर्थित नहीं हैं। डिफ़ॉल्ट AWS चेन का उपयोग करने के लिए क्रेडेंशियल छोड़ दें। अतिरिक्त आवश्यकता: pip install couchbase-mcp-server[bedrock-embeddings] |
"env": {
"CB_CONNECTION_STRING": "couchbases://connection-string",
"CB_USERNAME": "username",
"CB_PASSWORD": "password",
"CB_MCP_EMBEDDING_MODEL_PROVIDER": "openai",
"CB_MCP_EMBEDDING_MODEL": "text-embedding-3-small",
"CB_MCP_EMBEDDING_MODEL_API_KEY": "sk-..."
}
सभी विकल्प
operational server
के लिए हर पर्यावरण वेरिएबल और CLI फ़्लैग
Operational Insights server समान विकल्प स्वीकार करता है, सिवाय इसके कि इसकी अपनी कनेक्शन सेटिंग्स हैं और इसमें CB_MCP_EMBEDDING_MODEL_* विकल्प नहीं हैं।
| Environment Variable | CLI Argument | विवरण | डिफ़ॉल्ट |
|---|---|---|---|
CB_CONNECTION_STRING | --connection-string | Couchbase क्लस्टर से कनेक्शन स्ट्रिंग | आवश्यक |
CB_USERNAME | --username | बुनियादी प्रमाणीकरण के लिए आवश्यक बकेट्स तक पहुँच वाला उपयोगकर्ता नाम | आवश्यक (या mTLS के लिए Client Certificate और Key आवश्यक हैं) |
CB_PASSWORD | --password | बुनियादी प्रमाणीकरण के लिए पासवर्ड | आवश्यक (या mTLS के लिए Client Certificate और Key आवश्यक हैं) |
CB_CLIENT_CERT_PATH | --client-cert-path | mTLS प्रमाणीकरण के लिए क्लाइंट प्रमाणपत्र फ़ाइल का पथ | mTLS का उपयोग करने पर आवश्यक (या Username और Password आवश्यक हैं) |
CB_CLIENT_KEY_PATH | --client-key-path | mTLS प्रमाणीकरण के लिए क्लाइंट कुंजी फ़ाइल का पथ | mTLS का उपयोग करने पर आवश्यक (या Username और Password आवश्यक हैं) |
CB_CA_CERT_PATH | --ca-cert-path | TLS के लिए सर्वर रूट प्रमाणपत्र का पथ, यदि सर्वर स्व-हस्ताक्षरित/अविश्वसनीय प्रमाणपत्र के साथ कॉन्फ़िगर किया गया हो। Capella से कनेक्ट करने पर इसकी आवश्यकता नहीं होगी | |
CB_MCP_READ_ONLY_MODE | --read-only-mode | सभी डेटा संशोधनों (KV, Query, scope/collection प्रबंधन, index प्रबंधन और FTS index प्रबंधन) को रोकें। सक्षम होने पर, write टूल लोड नहीं किए जाते। | true |
CB_MCP_TRANSPORT | --transport | ट्रांसपोर्ट मोड: stdio, http | stdio |
CB_MCP_HOST | --host | HTTP ट्रांसपोर्ट मोड के लिए होस्ट | 127.0.0.1 |
CB_MCP_PORT | --port | HTTP ट्रांसपोर्ट मोड के लिए पोर्ट | 8000 |
CB_MCP_WORKERS | --workers | http ट्रांसपोर्ट के लिए सर्वर वर्कर प्रक्रियाओं की संख्या। 1 से अधिक मान stateless HTTP मोड में चलते हैं (Multiple Workers देखें) | 1 |
CB_MCP_STATELESS_HTTP | --stateless-http | प्रत्येक HTTP अनुरोध को प्रति-सत्र स्थिति के बिना संभालें। केवल http के साथ लागू; पुष्टि आवश्यक करने वाले टूल के साथ संयोजित नहीं किया जा सकता (Multiple Workers देखें) | जब workers > 1 हों तो true, अन्यथा false |
CB_MCP_DISABLED_TOOLS | --disabled-tools | अक्षम करने वाले टूल (Disabling Tools देखें) | None |
CB_MCP_CONFIRMATION_REQUIRED_TOOLS | --confirmation-required-tools | MCP elicitation के ज़रिए निष्पादन से पहले स्पष्ट उपयोगकर्ता पुष्टि आवश्यक करने वाले टूल (Requiring confirmation देखें) | None |
CB_MCP_LOG_LEVEL | --log-level | MCP सर्वर के लिए लॉगिंग स्तर: off, debug, info, warning, error (Logging देखें) | info |
CB_MCP_LOG_SINKS | --log-sinks | अल्पविराम से अलग किए गए लॉग गंतव्य: stderr, file, या दोनों (Logging देखें) | stderr |
CB_MCP_LOG_FILE | --log-file | प्रति-स्तर लॉग फ़ाइलों के लिए आधार पथ (केवल तभी उपयोग किया जाता है जब file sink सक्षम हो) | mcp_server.log |
CB_MCP_LOG_ROTATION_MAX_SIZE_MB | --log-rotation-max-size-mb | प्रत्येक लॉग फ़ाइल के रोटेशन से पहले उसका वैश्विक अधिकतम आकार MB में, जो हर स्तर पर लागू होता है, जब तक कि उसे ओवरराइड न किया जाए। 0 — या ऐसा मान जिसका उपयोग नहीं किया जा सकता, जैसे ऋणात्मक मान, nan या inf — अमान्य है और स्टार्टअप चेतावनी के साथ डिफ़ॉल्ट पर लौट जाता है | 1 (1 MB) |
CB_MCP_LOG_MAX_BYTES | --log-max-bytes | बहिष्कृत — CB_MCP_LOG_ROTATION_MAX_SIZE_MB (MB) का उपयोग करें। वैश्विक रोटेशन आकार बाइट में, जो पिछली संगतता के लिए अब भी लागू होता है; यदि CB_MCP_LOG_ROTATION_MAX_SIZE_MB भी सेट हो तो अनदेखा किया जाता है | सेट नहीं |
CB_MCP_LOG_ERROR_ROTATION_MAX_SIZE_MB | --log-error-rotation-max-size-mb | ERROR लॉग फ़ाइल के लिए रोटेशन आकार MB में; ERROR के लिए CB_MCP_LOG_ROTATION_MAX_SIZE_MB को ओवरराइड करता है | CB_MCP_LOG_ROTATION_MAX_SIZE_MB से विरासत में |
CB_MCP_LOG_WARNING_ROTATION_MAX_SIZE_MB | --log-warning-rotation-max-size-mb | WARNING लॉग फ़ाइल के लिए रोटेशन आकार MB में; WARNING के लिए CB_MCP_LOG_ROTATION_MAX_SIZE_MB को ओवरराइड करता है | CB_MCP_LOG_ROTATION_MAX_SIZE_MB से विरासत में |
CB_MCP_LOG_INFO_ROTATION_MAX_SIZE_MB | --log-info-rotation-max-size-mb | INFO लॉग फ़ाइल के लिए रोटेशन आकार MB में; INFO के लिए CB_MCP_LOG_ROTATION_MAX_SIZE_MB को ओवरराइड करता है | CB_MCP_LOG_ROTATION_MAX_SIZE_MB से विरासत में |
CB_MCP_LOG_DEBUG_ROTATION_MAX_SIZE_MB | --log-debug-rotation-max-size-mb | DEBUG लॉग फ़ाइल के लिए रोटेशन आकार MB में; DEBUG के लिए CB_MCP_LOG_ROTATION_MAX_SIZE_MB को ओवरराइड करता है | CB_MCP_LOG_ROTATION_MAX_SIZE_MB से विरासत में |
CB_MCP_LOG_RETENTION_BACKUP_COUNT | --log-retention-backup-count | प्रति-स्तर लॉग फ़ाइल के लिए रखी जाने वाली रोटेट की गई बैकअप फ़ाइलें (सक्रिय फ़ाइल को छोड़कर), जब तक कि ओवरराइड न किया जाए, हर स्तर पर लागू। 0 केवल सक्रिय फ़ाइल रखता है (Logging देखें) | 1 |
CB_MCP_LOG_ERROR_RETENTION_BACKUP_COUNT | --log-error-retention-backup-count | ERROR लॉग फ़ाइल के लिए रखे जाने वाले रोटेट किए गए बैकअप; ERROR के लिए वैश्विक संख्या को ओवरराइड करता है | CB_MCP_LOG_RETENTION_BACKUP_COUNT से विरासत में |
CB_MCP_LOG_WARNING_RETENTION_BACKUP_COUNT | --log-warning-retention-backup-count | WARNING लॉग फ़ाइल के लिए रखे जाने वाले रोटेट किए गए बैकअप; WARNING के लिए वैश्विक संख्या को ओवरराइड करता है | CB_MCP_LOG_RETENTION_BACKUP_COUNT से विरासत में |
CB_MCP_LOG_INFO_RETENTION_BACKUP_COUNT | --log-info-retention-backup-count | INFO लॉग फ़ाइल के लिए रखे जाने वाले रोटेट किए गए बैकअप; INFO के लिए वैश्विक संख्या को ओवरराइड करता है | CB_MCP_LOG_RETENTION_BACKUP_COUNT से विरासत में |
CB_MCP_LOG_DEBUG_RETENTION_BACKUP_COUNT | --log-debug-retention-backup-count | DEBUG लॉग फ़ाइल के लिए रखे जाने वाले रोटेट किए गए बैकअप; DEBUG के लिए वैश्विक संख्या को ओवरराइड करता है | CB_MCP_LOG_RETENTION_BACKUP_COUNT से विरासत में |
CB_MCP_OAUTH_JWT_JWKS_URI | --oauth-jwks-uri | bearer JWTs सत्यापित करने के लिए उपयोग किए जाने वाले पहचान प्रदाता का JWKS endpoint। issuer और audience के साथ सेट करने पर OAuth सक्षम होता है (OAuth 2.1 Authorization देखें) | None |
CB_MCP_OAUTH_JWT_ISSUER | --oauth-issuer | अपेक्षित JWT iss claim। OAuth सक्षम करने के लिए आवश्यक | None |
CB_MCP_OAUTH_JWT_AUDIENCE | --oauth-audience | अपेक्षित JWT aud claim। OAuth सक्षम करने के लिए आवश्यक | None |
CB_MCP_OAUTH_JWT_ALGORITHM | --oauth-algorithm | JWT हस्ताक्षर एल्गोरिदम: इनमें से एक RS256/384/512, ES256/384/512, PS256/384/512 | RS256 |
CB_MCP_OAUTH_MCP_BASE_URL | --oauth-mcp-base-url | इस सर्वर का सार्वजनिक आधार URL। सेट होने पर, PRM-सक्षम क्लाइंट को IdP खोजने देने के लिए RFC 9728 Protected Resource Metadata प्रकाशित करता है | None |
CB_MCP_OAUTH_SCOPE_READ_LABEL | --oauth-scope-read-label | 'read' पहुँच के रूप में माने जाने वाले OAuth scope लेबल को ओवरराइड करें (PRM में विज्ञापित और टोकन के scope/scp claim से मिलान किया जाता है)। इसका उपयोग तब करें जब आपका IdP canonical रूप जारी न कर सके | couchbase-mcp:read |
CB_MCP_OAUTH_SCOPE_WRITE_LABEL | --oauth-scope-write-label | 'write' पहुँच के रूप में माने जाने वाले OAuth scope लेबल को ओवरराइड करें; read लेबल के समान अर्थ | couchbase-mcp:write |
CB_MCP_AUDIT_LOG_ENABLED | --audit-log-enabled | ऑडिट लॉगिंग सक्षम करें — CB_MCP_LOG_* परिचालन लॉग से अलग sink, जिसमें स्थिर स्कीमा और अपनी retention होती है (Auditing देखें) | false |
CB_MCP_AUDIT_LOG_SINKS | --audit-log-sinks | अल्पविराम से अलग किए गए ऑडिट गंतव्य: console, file, या दोनों। console stderr पर लिखता है — stdout पर कभी नहीं, क्योंकि stdio में JSON-RPC प्रोटोकॉल होता है | console |
CB_MCP_AUDIT_LOG_FILE_PATH | --audit-log-file-path | ऑडिट लॉग फ़ाइल का पथ। जब file sinks में हो, तब आवश्यक; hostname और process id को extension से पहले जोड़ा जाता है (audit.log → audit.<host>.<pid>.log) | None |
CB_MCP_AUDIT_LOG_ROTATION_MAX_SIZE_MB | --audit-log-rotation-max-size-mb | रोटेशन से पहले सक्रिय ऑडिट फ़ाइल का अधिकतम आकार MB में। 0 आकार-आधारित रोटेशन बंद करता है | 10 (10 MB) |
CB_MCP_AUDIT_LOG_ROTATION_INTERVAL | --audit-log-rotation-interval | रोटेशन से पहले सक्रिय ऑडिट फ़ाइल की अधिकतम आयु, <value><unit> के रूप में, जहाँ इकाई d (24 घंटे) या w (7 दिन) है — जैसे 1d, 30d, 8w। 0 अंतराल-आधारित रोटेशन बंद करता है | 1d |
CB_MCP_AUDIT_LOG_RETENTION_MAX_BACKUPS | --audit-log-retention-max-backups | प्रति ऑडिट फ़ाइल रखे जाने वाले रोटेट किए गए बैकअप, सक्रिय फ़ाइल को छोड़कर। बैकअप gzip से संपीड़ित होते हैं। 0 कोई बैकअप नहीं रखता। यह एक फ़ाइल की सीमा तय करता है, डायरेक्टरी की नहीं — Auditing देखें | 10 |
CB_MCP_AUDIT_LOG_TOOL_ARGS | --audit-log-tool-args | ऑडिट लॉग में टूल आर्ग्युमेंट के मान दर्ज करें। डिफ़ॉल्ट रूप से बंद — इस रिलीज़ में कोई redaction नहीं है, इसलिए इसे सक्षम करने पर आर्ग्युमेंट ज्यों के त्यों लिखे जाते हैं, जिनमें पूरे दस्तावेज़ के मुख्य भाग भी शामिल हैं | false |
CB_MCP_AUDIT_LOG_DISABLED_EVENTS | --audit-log-disabled-events | दबाने के लिए ऑडिट इवेंट: अल्पविराम से अलग किए गए संख्यात्मक इवेंट ID (जैसे 61490,61492), या प्रति पंक्ति एक ID वाली फ़ाइल। केवल फ़िल्टर किए जा सकने वाले इवेंट दबाए जा सकते हैं | None |
CB_MCP_EMBEDDING_MODEL_PROVIDER | --embedding-model-provider | run_vector_query / run_vector_search के लिए embedding प्रदाता: इनमें से एक capella, openai, cohere, voyage, bedrock। सेट न होने पर, कॉन्फ़िगर किए जाने तक दोनों टूल के embedding चरण अक्षम रहते हैं — Embedding Provider Configuration देखें | None |
CB_MCP_EMBEDDING_MODEL | --embedding-model | कॉन्फ़िगर किए गए embedding प्रदाता का मॉडल नाम/ID | None |
CB_MCP_EMBEDDING_MODEL_API_KEY | --embedding-model-api-key | कॉन्फ़िगर किए गए प्रदाता की API key। bedrock द्वारा उपयोग नहीं की जाती (इसके बजाय AWS credential chain / CB_MCP_EMBEDDING_MODEL_AWS_* का उपयोग करता है) | None |
CB_MCP_EMBEDDING_MODEL_ENDPOINT | --embedding-model-endpoint | आधार URL ओवरराइड (OpenAI-संगत स्थानीय सर्वर, या Capella Model Service deployment का अपना URL — CB_MCP_EMBEDDING_MODEL_PROVIDER=capella होने पर आवश्यक) | None |
CB_MCP_EMBEDDING_MODEL_AWS_ACCESS_KEY_ID | --embedding-model-aws-access-key-id | AWS access key ID, केवल bedrock प्रदाता के लिए। डिफ़ॉल्ट AWS credential chain का उपयोग करने के लिए इसे छोड़ दें | None |
CB_MCP_EMBEDDING_MODEL_AWS_SECRET_ACCESS_KEY | --embedding-model-aws-secret-access-key | AWS secret access key, केवल bedrock प्रदाता के लिए | None |
CB_MCP_EMBEDDING_MODEL_AWS_REGION | --embedding-model-aws-region | AWS region, केवल bedrock प्रदाता के लिए। सेट न होने पर AWS SDK के अपने region resolution पर निर्भर करता है | None |
Operational Insights Server
operational-insights सर्वर स्व-प्रबंधित Operational Insights क्लस्टर से कनेक्ट होता है। Operational Insights, रीयल-टाइम ऐप्स और परिचालन इंटेलिजेंस के लिए एक रीयल-टाइम विश्लेषणात्मक डेटाबेस (RT-OLAP) है। यह सर्वर Capella के लिए उपलब्ध नहीं है। यह couchbase-operational-insights SDK का उपयोग करता है। यह परिचालन सर्वर से अलग, अपनी प्रक्रिया के रूप में चलता है।
[!IMPORTANT]
CB_OPERATIONAL_INSIGHTS_CONNECTION_STRINGएक HTTP(S) URL है,couchbase://कनेक्शन स्ट्रिंग नहीं — जैसेhttp://localhost:8095, या TLS परhttps://<host>:18095। यह सबसे आम गलत कॉन्फ़िगरेशन है।
Operational Insights Quick Start
PyPI से uvx के साथ:
{
"mcpServers": {
"couchbase-operational-insights": {
"command": "uvx",
"args": ["couchbase-mcp-server", "operational-insights"],
"env": {
"CB_OPERATIONAL_INSIGHTS_CONNECTION_STRING": "http://localhost:8095",
"CB_OPERATIONAL_INSIGHTS_USERNAME": "Administrator",
"CB_OPERATIONAL_INSIGHTS_PASSWORD": "password"
}
}
}
}
Docker के साथ:
{
"mcpServers": {
"couchbase-operational-insights": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "CB_OPERATIONAL_INSIGHTS_CONNECTION_STRING=http://host.docker.internal:8095",
"-e", "CB_OPERATIONAL_INSIGHTS_USERNAME=Administrator",
"-e", "CB_OPERATIONAL_INSIGHTS_PASSWORD=password",
"couchbase/mcp-server:latest", "operational-insights"
]
}
}
}
सोर्स से चलाने के लिए, अंतिम आर्ग्युमेंट के रूप में operational-insights और ऊपर दिए गए वेरिएबल के साथ operational source configuration का उपयोग करें।
Operational Insights Connection and Authentication
| पर्यावरण चर | CLI तर्क | विवरण |
|---|---|---|
CB_OPERATIONAL_INSIGHTS_CONNECTION_STRING | --connection-string | एंडपॉइंट URL (HTTP/HTTPS)। आवश्यक |
CB_OPERATIONAL_INSIGHTS_USERNAME | --username | उपयोगकर्ता नाम |
CB_OPERATIONAL_INSIGHTS_PASSWORD | --password | पासवर्ड |
CB_OPERATIONAL_INSIGHTS_CA_CERT_PATH | --ca-cert-path | स्व-हस्ताक्षरित/अविश्वसनीय सर्वर प्रमाणपत्र के लिए रूट प्रमाणपत्र (PEM) |
CB_OPERATIONAL_INSIGHTS_CLIENT_CERT_PATH | --client-cert-path | mTLS के लिए क्लाइंट प्रमाणपत्र — PEM (कुंजी सहित) या PKCS#12 बंडल (.p12/.pfx, बिना कुंजी)। इसके लिए https:// URL आवश्यक है; यह उपयोगकर्ता नाम/पासवर्ड को ओवरराइड करता है |
CB_OPERATIONAL_INSIGHTS_CLIENT_KEY_PATH | --client-key-path | क्लाइंट प्रमाणपत्र की निजी कुंजी (PEM)। PKCS#12 के लिए इसे सेट न करें |
CB_OPERATIONAL_INSIGHTS_CLIENT_CERT_PASSWORD | --client-cert-password | एन्क्रिप्ट की गई कुंजी या PKCS#12 बंडल का पासवर्ड |
CB_MCP_OPERATIONAL_INSIGHTS_QUERY_RESULT_MAX_SIZE | --operational-insights-query-result-max-size | क्वेरी परिणाम का अधिकतम आकार बाइट में। सेट न होने पर कोई सीमा नहीं। सेट होने पर, बजट पूरा होते ही पढ़ना रुक जाता है और प्रतिक्रिया में truncated: true बताया जाता है; जो पंक्ति सीमा से अधिक होगी, वह लौटाई नहीं जाती। 4 MiB (4194304) से बड़े मान 4 MiB तक सीमित कर दिए जाते हैं और स्टार्टअप पर stderr में चेतावनी दी जाती है |
CB_MCP_OPERATIONAL_INSIGHTS_ASYNC_QUERY_RESULT_TIMEOUT | --operational-insights-async-query-result-timeout | प्रत्येक async क्वेरी अनुरोध के लिए टाइमआउट सेकंड में: क्वेरी शुरू करना, उसकी स्थिति जाँचना, परिणाम प्राप्त करना, त्यागना और रद्द करना। परिणाम प्राप्त करते समय यह पूरे डाउनलोड पर लागू होता है, इसलिए इसे पढ़ने में इससे अधिक समय लेने वाला परिणाम विफल हो जाता है। बड़े परिणामों या धीमे कनेक्शन के लिए इसे बढ़ाएँ। धनात्मक पूर्णांक, डिफ़ॉल्ट 30, अधिकतम 600। बड़े मान 600 तक सीमित कर दिए जाते हैं और चेतावनी दी जाती है; अन्य कोई भी अमान्य मान चेतावनी के रूप में लॉग किया जाता है और 30 उपयोग किया जाता है |
सभी सामान्य कॉन्फ़िगरेशन लागू होते हैं, लेकिन ऑपरेशनल सर्वर से ये अंतर हैं:
- डिफ़ॉल्ट पोर्ट
8001है और डिफ़ॉल्ट लॉग फ़ाइलmcp_server_operational_insights.logहै, ताकि दोनों सर्वर साथ-साथ चल सकें। - केवल एक worker समर्थित है (
CB_MCP_WORKERS=1), क्योंकि async क्वेरी हैंडल प्रक्रिया की मेमोरी में रहते हैं। - इसमें कोई
CB_MCP_EMBEDDING_MODEL_*विकल्प नहीं हैं।
Operational Insights टूल
get_server_configuration_status को छोड़कर सभी नामों के आगे operational_insights_ लगाया जाता है, ताकि दोनों सर्वर बिना टकराव के एक क्लाइंट में पंजीकृत किए जा सकें। राइट टूल (✏️ से चिह्नित) डिफ़ॉल्ट रूप से केवल-पढ़ने का मोड चालू होने पर लोड नहीं होता।
सर्वर की स्थिति
| टूल | विवरण |
|---|---|
get_server_configuration_status | ऑपरेशनल सर्वर वाले टूल के समान |
डेटा मॉडल और स्कीमा की खोज
| टूल | विवरण |
|---|---|
operational_insights_get_databases_in_cluster | डेटाबेस की सूची बनाएँ |
operational_insights_get_scopes_in_database | डेटाबेस में स्कोप की सूची बनाएँ |
operational_insights_get_collections_in_scope | स्कोप में कलेक्शन (डेटासेट) की सूची बनाएँ |
operational_insights_get_schema_for_collection | नमूने लेकर कलेक्शन का JSON स्कीमा अनुमानित करें |
क्वेरी और इंडेक्स
| टूल | विवरण |
|---|---|
operational_insights_list_indexes | System.Metadata.Index से सेकेंडरी इंडेक्स की सूची बनाएँ |
operational_insights_explain_query | SQL++ स्टेटमेंट चलाए बिना उसका EXPLAIN करें |
operational_insights_run_query_sync | SQL++ चलाएँ और परिणाम आकार सीमा तक पंक्तियाँ लौटाएँ; इसके बजाय निर्यात भी कर सकते हैं। केवल-पढ़ने का मोड सर्वर-साइड लागू होता है |
operational_insights_run_query_async | लंबे समय तक चलने वाली क्वेरी शुरू करें और पंक्तियों की प्रतीक्षा किए बिना query_handle लौटाएँ; बड़े निर्यातों के लिए भी इसे प्राथमिकता दें। केवल-पढ़ने का मोड सर्वर-साइड लागू होता है |
operational_insights_get_async_query_results | async क्वेरी की स्थिति जाँचें; तैयार होने पर पंक्तियाँ (या निर्यात गंतव्य) लौटाता है |
operational_insights_discard_async_query_results | पूरी हो चुकी async क्वेरी के परिणाम मुक्त करें |
operational_insights_cancel_async_query | अभी भी चल रही async क्वेरी रोकें (केवल-पढ़ने के मोड में अनुमत) |
operational_insights_create_index ✏️ | CREATE INDEX के ज़रिए सेकेंडरी इंडेक्स बनाएँ |
Async क्वेरी शुरू करें → स्थिति जाँचें → त्यागें या रद्द करें, इस क्रम का पालन करती हैं: operational_insights_run_query_async एक query_handle लौटाता है, operational_insights_get_async_query_results को तैयार होने तक बार-बार जाँचा जाता है, फिर operational_insights_discard_async_query_results परिणाम मुक्त करता है, या operational_insights_cancel_async_query अभी भी चल रही क्वेरी रोकता है।
बड़े परिणामों का निर्यात
पंक्तियाँ लौटाने के बजाय, operational_insights_run_query_sync और operational_insights_run_query_async स्टेटमेंट को COPY ... TO में लपेटकर पंक्तियाँ बाहरी ऑब्जेक्ट स्टोरेज में लिख सकते हैं। तीनों copy_to_link (मौजूदा लिंक, जिसे CREATE LINK ... TYPE S3 से बनाया गया हो), copy_to_bucket और copy_to_path दें, और वैकल्पिक रूप से copy_to_format दें (json डिफ़ॉल्ट है, या parquet)। इसके बाद टूल बिना पंक्तियों के पुष्टि लौटाता है:
{
"success": true,
"exported": true,
"destination": {"link": "s3Link", "bucket": "my-exports", "path": "exports/run1", "format": "json"},
"message": "Results were written to my-exports/exports/run1 as json. ..."
}
- आंशिक गंतव्य अस्वीकार कर दिया जाता है; चुपचाप पंक्तियाँ लौटाई नहीं जातीं।
- सिंक टूल पूरे अपलोड की प्रतीक्षा करता है; बड़े निर्यातों के लिए async टूल को प्राथमिकता दें।
- निर्यात केवल-पढ़ने के मोड में अवरुद्ध हैं (वे बाहरी स्टोरेज में लिखते हैं), इसलिए इनके लिए
CB_MCP_READ_ONLY_MODE=falseयाcouchbase-mcp:writeवाला टोकन आवश्यक है। csvउपलब्ध नहीं है, क्योंकि इसके लिए स्पष्ट आउटपुट स्कीमा चाहिए, जिसका अनुमान किसी मनमानेSELECTसे नहीं लगाया जा सकता।
सामान्य कॉन्फ़िगरेशन
ये सेटिंग दोनों सर्वरों पर एक ही तरह से काम करती हैं। हर विकल्प को पर्यावरण चर के रूप में या सबकमांड के बाद CLI फ़्लैग के रूप में सेट किया जा सकता है।
सुरक्षा नियंत्रण
इन सुरक्षा सिद्धांतों का पालन करें:
- डेटाबेस उपयोगकर्ता को न्यूनतम आवश्यक विशेषाधिकार दें — RBAC ही आधिकारिक सुरक्षा सीमा है (नीचे देखें)।
- एजेंट को केवल आवश्यक टूल दें और बाकी अक्षम करें — लोड किया गया हर टूल वह चीज़ है जिसे LLM कॉल कर सकता है। टूल सूची को न्यूनतम रखने के लिए केवल-पढ़ने का मोड और
CB_MCP_DISABLED_TOOLSका उपयोग करें। - जिन संवेदनशील टूल को चालू रखते हैं, उनके लिए पुष्टि आवश्यक करें — पुष्टि आवश्यक करना देखें।
नीचे दिए गए नियंत्रण व्यापक से संकीर्ण क्रम में तीन परतें बनाते हैं। इनका साथ में उपयोग करें — लेकिन याद रखें कि इनमें से कोई भी RBAC का स्थान नहीं लेता।
[!IMPORTANT] डेटाबेस उपयोगकर्ता की RBAC अनुमतियाँ ही आधिकारिक सुरक्षा नियंत्रण हैं। उदाहरण के लिए,
upsert_document_by_idऔरdelete_document_by_idको अक्षम करने सेrun_sql_plus_plus_queryकोINSERT/UPDATE/DELETE/MERGEचलाने से नहीं रोका जा सकता — केवल-पढ़ने का मोड या अनुपस्थित RBAC अनुमतियाँ ही ऐसा कर सकती हैं। सर्वर के डेटाबेस उपयोगकर्ता को केवल आवश्यक अनुमतियाँ दें।
केवल-पढ़ने का मोड
CB_MCP_READ_ONLY_MODE (डिफ़ॉल्ट true) लिखने के लिए एकमात्र स्विच है:
true— प्रत्येक सर्वर की टूल सूची में ✏️ से चिह्नित राइट टूल लोड नहीं होते, और डेटा या संरचना में बदलाव करने वाली क्वेरी अवरुद्ध होती हैं।false— राइट टूल लोड होते हैं और बदलाव करने वाली क्वेरी की अनुमति होती है।
टूल अक्षम करना
CB_MCP_DISABLED_TOOLS टूल को खोज से पूरी तरह हटा देता है। यह कॉमा से अलग की गई सूची या प्रति पंक्ति एक टूल नाम वाली फ़ाइल का पथ स्वीकार करता है (# टिप्पणी शुरू करता है):
CB_MCP_DISABLED_TOOLS="upsert_document_by_id,delete_document_by_id"
# or
CB_MCP_DISABLED_TOOLS=/path/to/disabled_tools.txt
# disabled_tools.txt
# Write operations
upsert_document_by_id
delete_document_by_id
# Index advisor
get_index_advisor_recommendations
Capella पर, ऑपरेशनल सर्वर कुछ एडमिन टूल अपने-आप अक्षम भी करता है।
पुष्टि आवश्यक करना (elicitation)
CB_MCP_CONFIRMATION_REQUIRED_TOOLS सूचीबद्ध टूल चलने से पहले उपयोगकर्ता से MCP elicitation के ज़रिए पुष्टि माँगता है। यह अक्षम किए गए टूल के समान कॉमा से अलग की गई सूची या फ़ाइल फ़ॉर्मैट स्वीकार करता है:
CB_MCP_CONFIRMATION_REQUIRED_TOOLS="delete_document_by_id,replace_document_by_id"
- यदि क्लाइंट elicitation का समर्थन करता है, तो टूल चलने से पहले उपयोगकर्ता से पुष्टि माँगी जाती है।
- यदि वह इसका समर्थन नहीं करता, तो पिछली संगतता के लिए टूल बिना पुष्टि के चलता है।
- पुष्टि के लिए MCP सत्र आवश्यक है, इसलिए इसे स्टेटलेस HTTP (
CB_MCP_STATELESS_HTTP=trueया 1 से अधिकCB_MCP_WORKERS) के साथ इस्तेमाल नहीं किया जा सकता। इस संयोजन के साथ सर्वर शुरू करने से इनकार कर देता है। लोड बैलेंसर के पीछे पुष्टि के लिए स्टिकी सत्र आवश्यक हैं — लोड बैलेंसर देखें।
ट्रांसपोर्ट
| ट्रांसपोर्ट | उपयोग | एंडपॉइंट |
|---|---|---|
stdio (डिफ़ॉल्ट) | एक स्थानीय क्लाइंट, जो सर्वर को सबप्रोसेस के रूप में शुरू करता है | — |
http | एक सर्वर साझा करने वाले कई क्लाइंट; OAuth और हेल्थ चेक, तथा ऑपरेशनल सर्वर पर workers का समर्थन करता है | http://<host>:<port>/mcp |
ट्रांसपोर्ट को CB_MCP_TRANSPORT से, बाइंड एड्रेस को CB_MCP_HOST से (डिफ़ॉल्ट 127.0.0.1) और पोर्ट को CB_MCP_PORT से सेट करें (सेट न होने पर प्रत्येक सर्वर का डिफ़ॉल्ट पोर्ट)। OAuth के बिना, HTTP एंडपॉइंट पर प्रमाणीकरण नहीं होता।
uvx couchbase-mcp-server operational \
--connection-string='<couchbase_connection_string>' \
--username='<database_username>' \
--password='<database_password>' \
--transport=http
फिर अपने क्लाइंट को URL पर निर्देशित करें:
{
"mcpServers": {
"couchbase-http": {
"url": "http://localhost:8000/mcp"
}
}
}
कई workers
एक प्रक्रिया अधिकतम लगभग एक CPU कोर का उपयोग करती है। --workers N (CB_MCP_WORKERS) एक ही होस्ट और पोर्ट के पीछे N प्रक्रियाएँ चलाता है; उपलब्ध कोर की संख्या एक अच्छा शुरुआती मान है। केवल ऑपरेशनल सर्वर workers का समर्थन करता है। एक से अधिक worker होने पर:
httpट्रांसपोर्ट आवश्यक है और सर्वर स्टेटलेस HTTP मोड में चलता है, क्योंकि क्लाइंट के अनुरोध अलग-अलग workers तक पहुँच सकते हैं। उदाहरण के लिए, स्टिकी सत्रों के बिना लोड बैलेंसर के पीछे, एक worker पर भी--stateless-http=trueसेट कर सकते हैं।- पुष्टि आवश्यक करने वाले टूल इस्तेमाल नहीं किए जा सकते।
- हर प्रक्रिया अपनी लॉग फ़ाइलें लिखती है, जिनके नाम में होस्ट और प्रक्रिया ID (
mcp_server.<host>.<pid>.info.log) शामिल होते हैं — एक सेट सुपरवाइज़र के लिए और एक हर worker के लिए।
लोड बैलेंसर
आप लोड बैलेंसर के पीछे कई सर्वर इंस्टेंस चला सकते हैं। हर इंस्टेंस अपने MCP सत्र अपनी मेमोरी में रखता है, इसलिए लोड बैलेंसर की सेटिंग तय करती है कि क्या काम करेगा:
| लोड बैलेंसर | सर्वर सेटिंग | पुष्टि आवश्यक करने वाले टूल |
|---|---|---|
स्टिकी सत्र, Mcp-Session-Id अनुरोध हेडर के आधार पर रूट किए गए | एक worker, स्टेटफुल (डिफ़ॉल्ट) | समर्थित |
| स्टिकी सत्र नहीं | --stateless-http=true | समर्थित नहीं — कॉन्फ़िगर किए जाने पर सर्वर शुरू होने से इनकार कर देता है |
- स्टिकी सत्रों के बिना, स्टेटफुल इंस्टेंस हर उस अनुरोध को अस्वीकार करता है जिसका सत्र किसी दूसरे इंस्टेंस पर बनाया गया था। ऐसी स्थिति में स्टेटलेस मोड का उपयोग करें।
- कुकी के बजाय
Mcp-Session-Idहेडर के आधार पर रूट करें। कई MCP क्लाइंट कुकीज़ बनाए नहीं रखते। - यदि कोई इंस्टेंस रीस्टार्ट होता है या फ़ेलओवर होता है, तो उसके सत्र और पुष्टि के लंबित अनुरोध खो जाते हैं। क्लाइंट को नया सत्र शुरू करना होगा।
- Operational Insights async क्वेरी अपने
query_handleको उस इंस्टेंस की मेमोरी में रखती हैं जिसने क्वेरी शुरू की थी, स्टेटलेस मोड में भी। किसी दूसरे इंस्टेंस पर क्वेरी की स्थिति जाँचने, उसे त्यागने या रद्द करने परUnknown query_handleलौटता है। इन टूल का उपयोग एक ही इंस्टेंस के साथ करें, या स्टिकी सत्रों के साथ ताकि सभी कॉल उसी इंस्टेंस तक पहुँचें जिसने क्वेरी शुरू की थी। स्टेटलेस मोड मेंMcp-Session-Idनहीं भेजा जाता, इसलिए किसी अन्य affinity key, जैसे क्लाइंट IP पते, की आवश्यकता होती है।
हेल्थ चेक
HTTP मोड में, GET /health MCP पोर्ट पर {"status": "ok", "server": "<server>"} लौटाता है। यह liveness check है: यह क्लस्टर से कनेक्ट नहीं होता (इसलिए क्लस्टर आउटेज से स्वस्थ कंटेनर रीस्टार्ट नहीं होता), OAuth चालू होने पर भी प्रमाणीकरण की आवश्यकता नहीं होती, और हर worker इसे सर्व करता है। प्रोब के उदाहरणों के लिए Docker देखें।
OAuth 2.1 प्राधिकरण
--transport=http के साथ, दोनों में से कोई भी सर्वर OAuth 2.1 resource server के रूप में काम कर सकता है और आपके identity provider के JWKS के विरुद्ध bearer JWT को मान्य कर सकता है। यह ऐसे किसी भी OAuth 2.1/OIDC provider के साथ काम करता है जो JWKS प्रकाशित करता है, और टोकन जारी या उपयोगकर्ता प्रबंधित नहीं करता। stdio पर 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 प्रकाशित करता है, ताकि क्लाइंट authorization server खोज सकें।- पहुँच टोकन के
scope/scpclaim में मौजूद दो scopes से नियंत्रित होती है:couchbase-mcp:read(रीड टूल) औरcouchbase-mcp:write(राइट टूल)। पूर्ण पहुँच के लिए दोनों आवश्यक हैं। यदि आपका IdP ये लेबल जारी नहीं कर सकता, तो इन्हेंCB_MCP_OAUTH_SCOPE_READ_LABEL/CB_MCP_OAUTH_SCOPE_WRITE_LABELसे बदलें। दोनों सर्वर समान लेबल इस्तेमाल करते हैं, इसलिए एक IdP कॉन्फ़िगरेशन दोनों के लिए पर्याप्त है।
uvx couchbase-mcp-server operational \
--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>'
IdP सेटअप के लिए ऑपरेशनल सर्वर और Operational Insights सर्वर के OAuth दस्तावेज़ देखें।
लॉगिंग
डिफ़ॉल्ट रूप से, हर सर्वर info स्तर पर stderr में लॉग लिखता है।
CB_MCP_LOG_LEVEL—off,error,warning,info(जीवनचक्र इवेंट और टूल कॉल) याdebug।CB_MCP_LOG_SINKS—stderr,file, या दोनों।fileके साथ, हर स्तर की एक रोटेट होती फ़ाइलCB_MCP_LOG_FILEके पास लिखी जाती है (mcp_server.info.log,mcp_server.error.log, …)।- रोटेशन और प्रतिधारण —
CB_MCP_LOG_ROTATION_MAX_SIZE_MB(डिफ़ॉल्ट 1 MB) औरCB_MCP_LOG_RETENTION_BACKUP_COUNT(डिफ़ॉल्ट 1) हर स्तर पर लागू होते हैं;CB_MCP_LOG_<LEVEL>_ROTATION_MAX_SIZE_MB/CB_MCP_LOG_<LEVEL>_RETENTION_BACKUP_COUNTसे प्रति स्तर ओवरराइड करें। अमान्य आकार स्टार्टअप चेतावनी के साथ डिफ़ॉल्ट पर लौट जाते हैं।CB_MCP_LOG_MAX_BYTESअब अप्रचलित है। - कॉन्फ़िग स्नैपशॉट —
fileसिंक के साथ, परिवेश और सर्वर कॉन्फ़िग का संपादित JSON रिकॉर्ड सहायता के लिए हर स्टार्ट परmcp_server_config.log.jsonमें लिखा जाता है।
# Debug logging to stderr and rotating per-level files
uvx couchbase-mcp-server operational --log-level=debug --log-sinks=stderr,file
आपका MCP क्लाइंट आमतौर पर सर्वर के stderr को भी कैप्चर करता है — स्थान जानने के लिए क्लाइंट सेटअप देखें। विवरण: ऑपरेशनल सर्वर और Operational Insights सर्वर के लॉगिंग दस्तावेज़।
ऑडिटिंग
ऑडिट लॉगिंग यह रिकॉर्ड करती है कि किसने क्या किया और क्या उसे अनुमति थी — यह ऑपरेशनल लॉग से अलग है, जो बताता है कि क्या गलत हुआ। किसी एजेंट के लिए इसका उत्तर देने में MCP सर्वर ही एकमात्र परत है: हर अनुरोध क्लस्टर तक एक ही डेटाबेस उपयोगकर्ता के रूप में पहुँचता है, और स्कोप अस्वीकृति, केवल-पढ़ने की रोक या अस्वीकृत पुष्टि जैसे निर्णय क्लस्टर तक कभी पहुँचते ही नहीं।
ऑडिटिंग डिफ़ॉल्ट रूप से बंद है। इसे CB_MCP_AUDIT_LOG_ENABLED=true से चालू करें; CB_MCP_AUDIT_LOG_SINKS=file और CB_MCP_AUDIT_LOG_FILE_PATH सेट न करने पर यह stderr में लिखती है।
# 90 days of daily, gzipped audit files
uvx couchbase-mcp-server operational --audit-log-enabled=true \
--audit-log-sinks=file --audit-log-file-path=/var/log/cb-mcp/audit.log \
--audit-log-rotation-interval=1d --audit-log-rotation-max-size-mb=0 \
--audit-log-retention-max-backups=90
रिकॉर्ड JSON Lines में होते हैं और Couchbase Server तथा Sync Gateway जैसी ही फ़ील्ड शब्दावली का उपयोग करते हैं:
{"id":61522,"name":"document write","description":"A document write operation was requested through a tool","timestamp":"2026-09-29T09:14:22.418Z","real_userid":{"domain":"oauth","user":"agent-svc-7"},"server":{"version":"1.0.2","host":"mcp-01"},"cid":"9f2c...","outcome":"success","tool_name":"upsert_document_by_id","required_scope":"write","ks":"travel-sample.inventory.airline","cb_userid":"mcp_service"}
ऑडिटिंग का व्यवहार
- पहचान —
real_useridकॉलर है:oauth(टोकन का विषय),local(stdio पर OS उपयोगकर्ता) याanonymous(OAuth के बिना HTTP, जो स्टार्टअप पर चेतावनी देता है)। - सहसंबंध —
cidएक अनुरोध के सभी रिकॉर्ड को समूहित करता है और SQL++client_context_idके रूप में भेजा जाता है, इसलिए यह Couchbase Server केclientContextIdसे सटीक रूप से जुड़ता है। जानबूझकर कोई सत्र पहचानकर्ता नहीं है। - इवेंट — एक निश्चित, क्रमांकित सूची (जीवनचक्र, initialize, टोकन अस्वीकृत, स्कोप अस्वीकृत, केवल-पढ़ने की रोक, पुष्टि अस्वीकृत/छोड़ी गई, और हर टूल श्रेणी के लिए पढ़ने/लिखने की जोड़ी)।
queryऔरsearchअपवाद हैं: हर एक को पढ़ने/लिखने की जोड़ी के बजाय एकल इवेंट के रूप में रिकॉर्ड किया जाता है, क्योंकि स्टेटमेंट-आधारित और खोज सतहों के लिए यह अंतर विश्वसनीय रूप से तय नहीं किया जा सकता। वेक्टर ऑपरेशन इन दोनों श्रेणियों के अंतर्गत आते हैं। पूरी सूची पैकेज मेंdescriptor.jsonके रूप में शामिल है। ऑपरेशनल सर्वर ब्लॉक0xF000(61440) का, Operational Insights0x10000(65536) का उपयोग करता है, और दोनों मुख्य इवेंट के लिए0xE000(57344) साझा करते हैं। - फ़िल्टरिंग —
CB_MCP_AUDIT_LOG_DISABLED_EVENTSसंख्यात्मक ID के आधार पर पढ़ने वाले इवेंट दबाता है (उदा.61490,61492)। लिखने और सुरक्षा इवेंट बंद नहीं किए जा सकते, न ही एकल-इवेंट श्रेणियाँquery(61507, या Operational Insights पर 65603) औरsearch(61510) बंद की जा सकती हैं: हर श्रेणी के लिए एक इवेंट उसके लिखने और पढ़ने, दोनों को कवर करता है, इसलिए उसे बंद करने से म्यूटेशन रिकॉर्ड खो जाएगा। - रोटेशन — आकार (
CB_MCP_AUDIT_LOG_ROTATION_MAX_SIZE_MB, डिफ़ॉल्ट 10) और आयु (CB_MCP_AUDIT_LOG_ROTATION_INTERVAL, डिफ़ॉल्ट1d) के आधार पर, जो भी पहले हो;0दोनों में से किसी को बंद कर देता है। रोटेट की गई फ़ाइलों पर टाइमस्टैम्प लगाया जाता है और उन्हें gzip किया जाता है; लाइव फ़ाइलtail -fके लिए सादा टेक्स्ट रहती है। - प्रति-प्रक्रिया फ़ाइलें — नाम में होस्ट और pid जोड़े जाते हैं (
audit.log→audit.<host>.<pid>.log), इसलिए एक साथ चल रही प्रक्रियाएँ कभी एक ही फ़ाइल साझा नहीं करतीं। - प्रति फ़ाइल प्रतिधारण —
CB_MCP_AUDIT_LOG_RETENTION_MAX_BACKUPS(डिफ़ॉल्ट 10) एक फ़ाइल के बैकअप की सीमा तय करता है। हर नई प्रक्रिया नई फ़ाइल लिखती है और पुरानी फ़ाइलें हटाती नहीं है, इसलिए वॉल्यूम का आकार तय करें या पुरानीaudit.*.log*फ़ाइलें साफ़ करें। - विफलता पर भी सेवा जारी — फ़ाइल में लिखना संभव न होने पर सर्वर सेवा जारी रखता है और छूटे हुए रिकॉर्ड गिनता है;
get_server_configuration_statuswritten/dropped/write_errorsकी रिपोर्ट करता है। - टूल आर्ग्युमेंट — केवल
CB_MCP_AUDIT_LOG_TOOL_ARGS=trueके साथ रिकॉर्ड किए जाते हैं, जो स्टार्टअप पर चेतावनी देता है। इस रिलीज़ में कोई संपादन नहीं होता, इसलिए पूरे दस्तावेज़ के मुख्य भागों सहित आर्ग्युमेंट ज्यों के त्यों लिखे जाते हैं।
क्लाइंट सेटअप
हर क्लाइंट को अपने कॉन्फ़िगरेशन स्थान में ऑपरेशनल या Operational Insights के क्विक स्टार्ट से सर्वर कॉन्फ़िगरेशन चाहिए। नीचे दिए गए उदाहरण ऑपरेशनल सर्वर का उपयोग करते हैं।
Claude Desktop
- कॉन्फ़िगरेशन फ़ाइल खोलें (MCP क्विकस्टार्ट गाइड देखें):
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
- सर्वर को
mcpServersके अंतर्गत जोड़ें और Claude Desktop को रीस्टार्ट करें।
लॉग: macOS ~/Library/Logs/Claude, Windows %APPDATA%\Claude\Logs। MCP समस्या-निवारण गाइड देखें।
Cursor
- Cursor Settings > Tools & Integrations > MCP Tools पर जाएँ (Cursor के MCP दस्तावेज़ देखें), या एक-क्लिक Cursor में इंस्टॉल करें लिंक का उपयोग करें — फिर प्लेसहोल्डर कनेक्शन स्ट्रिंग और क्रेडेंशियल बदलें।
- कॉन्फ़िगरेशन को
mcpServersके अंतर्गत जोड़ें और सहेजें। - MCP सर्वर सूची रीफ़्रेश करके जाँचें कि
couchbaseसक्षम है।
लॉग: नीचे के पैनल में Output खोलें और Cursor MCP चुनें।
Windsurf Editor
- Command Palette > Windsurf MCP Configuration Panel खोलें, या Windsurf Settings > Advanced > Cascade > Model Context Protocol (MCP) Servers पर जाएँ (Windsurf के MCP दस्तावेज़ देखें)।
- Add Server > Add custom server पर क्लिक करें, कॉन्फ़िगरेशन पेस्ट करें और सहेजें।
- सर्वर सूची रीफ़्रेश करके जाँचें कि
couchbaseसक्षम है।
VS Code
VS Code शीर्ष-स्तरीय कुंजी के रूप में mcpServers के बजाय servers का उपयोग करता है। किसी वर्कस्पेस के लिए कॉन्फ़िगरेशन को .vscode/mcp.json में रखें, या सभी वर्कस्पेस के लिए MCP: Open User Configuration चलाएँ (VS Code के MCP दस्तावेज़ देखें):
{
"servers": {
"couchbase": {
"command": "uvx",
"args": ["couchbase-mcp-server", "operational"],
"env": {
"CB_CONNECTION_STRING": "couchbases://connection-string",
"CB_USERNAME": "username",
"CB_PASSWORD": "password"
}
}
}
}
फ़ाइल सहेजने पर सर्वर शुरू हो जाता है; उसे प्रबंधित करने के लिए ऊपर दिए गए Running | Stop | n Tools ऐक्शन का उपयोग करें।
लॉग: MCP: List Servers चलाएँ, couchbase चुनें, फिर Show Output चुनें।
JetBrains IDEs
- AI Assistant या Junie प्लगइन इंस्टॉल करें।
- Settings > Tools > AI Assistant (or Junie) > MCP Server पर जाएँ, + पर क्लिक करें, कॉन्फ़िगरेशन जोड़ें और Apply पर क्लिक करें।
- इसके टूल देखने के लिए सर्वर की स्थिति पर माउस ले जाएँ।
लॉग: Help > Show Log in Finder (Explorer) > mcp > couchbase।
Docker
पहले से बने इमेज Docker Hub पर couchbase/mcp-server के रूप में प्रकाशित किए जाते हैं, और सर्वर Docker MCP Catalog में सूचीबद्ध है। कंटेनर को ऊपर दिए गए समान पर्यावरण वेरिएबल से कॉन्फ़िगर करें। टैग, वॉल्यूम और हेल्थ-चेक उदाहरणों के लिए Docker Hub पेज (DOCKER.md) देखें।
HTTP पर चलाते समय ध्यान दें कि कंटेनर के बाहर से पहुँचने योग्य होने के लिए सर्वर को 0.0.0.0 से बाइंड होना चाहिए:
docker run --rm \
-e CB_CONNECTION_STRING='<couchbase_connection_string>' \
-e CB_USERNAME='<database_user>' \
-e CB_PASSWORD='<database_password>' \
-e CB_MCP_TRANSPORT=http \
-e CB_MCP_HOST=0.0.0.0 \
-p 8000:8000 \
couchbase/mcp-server:latest operational
- यदि Couchbase आपकी होस्ट मशीन पर चलता है, तो कनेक्शन स्ट्रिंग के रूप में
couchbase://host.docker.internalका उपयोग करें (Docker नेटवर्किंग देखें)। किसी अन्य कंटेनर के नेटवर्क से जुड़ने के लिए--network=<your_network>का उपयोग करें। - Operational Insights सर्वर चलाने के लिए
operationalके बजायoperational-insightsजोड़ें (पोर्ट8001)।
सोर्स से इमेज बनाना
docker build -t mcp/couchbase-src .
./build.sh [image-name] CI जैसे ही आर्ग्युमेंट के साथ बिल्ड करता है — यह GIT_COMMIT_HASH और BUILD_DATE बिल्ड आर्ग्युमेंट सेट करता है और इमेज को latest तथा <short-commit> टैग देता है (डिफ़ॉल्ट नाम 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 .
# Check the labels
docker inspect --format='{{json .Config.Labels}}' mcp/couchbase-src:latest
समस्या-निवारण
पूरी गाइड के लिए ऑपरेशनल सर्वर और Operational Insights सर्वर के समस्या-निवारण दस्तावेज़, तथा ऑपरेशनल सर्वर और Operational Insights सर्वर के सुरक्षा दिशानिर्देश देखें। त्वरित जाँच:
- कनेक्शन स्ट्रिंग, उपयोगकर्ता नाम/पासवर्ड या प्रमाणपत्र पथ जाँचें।
- Capella के लिए सुनिश्चित करें कि क्लस्टर, सर्वर चलाने वाली मशीन से कनेक्शन की अनुमति देता है।
- सुनिश्चित करें कि डेटाबेस उपयोगकर्ता कम-से-कम एक बकेट तक पहुँच सकता है।
- यदि क्लाइंट को
uv/uvxनहीं मिल रहा है, तोcommandमें पूर्ण पथ रखें। - सोर्स से चलाते समय कॉन्फ़िगरेशन में रिपॉज़िटरी पथ जाँचें और अपडेट पुल करने के बाद
uv syncचलाएँ। - सर्वर द्वारा वास्तव में हल किए गए कॉन्फ़िगरेशन को देखने के लिए
get_server_configuration_statusचलाएँ, और अपने क्लाइंट के लॉग जाँचें (क्लाइंट सेटअप देखें)।
अक्सर पूछे जाने वाले प्रश्न
Claude Desktop को Couchbase से कैसे जोड़ूँ? क्विक स्टार्ट कॉन्फ़िगरेशन को claude_desktop_config.json में जोड़ें और Claude Desktop रीस्टार्ट करें — क्लाइंट सेटअप देखें।
क्या मैं इसे Couchbase Capella के साथ उपयोग कर सकता हूँ? हाँ, ऑपरेशनल सर्वर के साथ: यही कॉन्फ़िगरेशन Capella और स्वयं-प्रबंधित क्लस्टर, दोनों के लिए काम करता है, हालाँकि कुछ एडमिन टूल केवल स्वयं-प्रबंधित क्लस्टर पर उपलब्ध हैं (टूल देखें)। Operational Insights सर्वर केवल स्वयं-प्रबंधित Operational Insights क्लस्टर के लिए है।
क्या AI एजेंट को मेरे डेटाबेस में लिखने देना सुरक्षित है? डिफ़ॉल्ट रूप से नहीं; कोई लेखन टूल लोड नहीं होता और SQL++ में बदलाव करना अवरुद्ध है। यदि आप लेखन सक्षम करते हैं, तब भी अलग-अलग टूल बंद कर सकते हैं या पुष्टि आवश्यक कर सकते हैं — लेकिन Couchbase उपयोगकर्ता की RBAC अनुमतियाँ ही वास्तविक सुरक्षा सीमा बनी रहती हैं। सुरक्षा नियंत्रण देखें।
क्या मुझे SQL++ जानना ज़रूरी है? नहीं। सामान्य भाषा में पूछें और सहायक आपके लिए SQL++ लिख देगा (run_sql_plus_plus_query)। यह क्वेरी प्लान समझा भी सकता है या सुझावों के लिए Index Advisor से पूछ सकता है।
STDIO या Streamable HTTP? एक स्थानीय क्लाइंट के लिए STDIO। OAuth के साथ क्लाइंटों के बीच एक सर्वर साझा करने के लिए Streamable HTTP। ट्रांसपोर्ट देखें।
क्या Couchbase आधिकारिक रूप से इसका समर्थन करता है? हाँ, Couchbase AI Data Plane लाइसेंस के साथ। इसके बिना, Couchbase इंजीनियर GitHub इश्यू के माध्यम से यथासंभव सहायता करते हैं। सहायता नीति देखें।
योगदान
योगदान का स्वागत है — बग फ़िक्स, सुविधाएँ और दस्तावेज़। बग की रिपोर्ट करने या सहायता माँगने के लिए GitHub इश्यू खोलें।
डेवलपमेंट सेटअप, लिंटिंग, परीक्षण, प्रोजेक्ट संरचना और कार्यप्रवाह के लिए CONTRIBUTING.md देखें। शुरुआत करने के लिए:
git clone https://github.com/couchbase/mcp-server-couchbase.git
cd mcp-server-couchbase
uv sync --extra dev
uv run pre-commit install
./scripts/lint.sh
इंटीग्रेशन परीक्षण लाइव क्लस्टर के विरुद्ध चलते हैं। CB_CONNECTION_STRING, CB_USERNAME, CB_PASSWORD और वैकल्पिक रूप से CB_MCP_TEST_BUCKET एक्सपोर्ट करें; Operational Insights परीक्षण CB_OPERATIONAL_INSIGHTS_CONNECTION_STRING / _USERNAME / _PASSWORD का भी उपयोग करते हैं और इनके सेट न होने पर छोड़ दिए जाते हैं। फिर चलाएँ:
uv run --extra dev pytest tests/integration -v
उपयोग डेटा, LLM जोखिम और सहायता नीति
उपयोग डेटा संग्रह
यह उत्पाद उपयोग और प्रदर्शन संबंधी डेटा (जैसे उत्पाद का नाम और संस्करण) तथा ब्राउज़र की जानकारी (जैसे IP पता) (सामूहिक रूप से, "उपयोग डेटा") अपने आप एकत्र करता है। Couchbase, उपयोग डेटा के साथ-साथ आपके द्वारा Couchbase को दिए जा सकने वाले अन्य डेटा (जैसे आपका उपयोगकर्ता नाम या ईमेल पता) का उपयोग हमारे उत्पादों को विकसित और बेहतर बनाने तथा हमारे बिक्री और विपणन कार्यक्रमों को दिशा देने के लिए करता है। हम Couchbase उत्पादों में आपके द्वारा संग्रहीत किसी भी डेटा तक पहुँच नहीं बनाते या उसे एकत्र नहीं करते। हम समग्र उपयोग के पैटर्न समझने और अपने उत्पादों को आपके लिए अधिक उपयोगी बनाने के लिए उपयोग डेटा का उपयोग करते हैं। Couchbase जानकारी कैसे एकत्र, सुरक्षित और संसाधित करता है, इस बारे में अधिक जानकारी के लिए, कृपया https://www.couchbase.com/privacy-policy. पर उपलब्ध Couchbase गोपनीयता नीति देखें।
LLM से जुड़े जोखिम
- बड़े भाषा मॉडल और इसी तरह की तकनीक के उपयोग में जोखिम शामिल हैं, जिनमें गलत या हानिकारक आउटपुट की संभावना भी है।
- Couchbase ऐसे आउटपुट की गुणवत्ता या सटीकता की समीक्षा या मूल्यांकन नहीं करता, और ऐसे आउटपुट Couchbase के विचारों को प्रतिबिंबित नहीं कर सकते।
- बड़े भाषा मॉडल और संबंधित तकनीक का उपयोग करना है या नहीं, यह तय करने और इनके उपयोग पर लागू किसी भी लाइसेंस की शर्तों, उपयोग की शर्तों तथा अपने संगठन की नीतियों का पालन करने की पूरी ज़िम्मेदारी आपकी है।
सहायता नीति
Couchbase MCP Server ओपन सोर्स है और Couchbase के इंजीनियर इसका रखरखाव करते हैं। सहायता पाने का तरीका इस बात पर निर्भर करता है कि आप इसका उपयोग कैसे करते हैं:
- सामुदायिक उपयोग — GitHub इश्यू खोलकर बग की रिपोर्ट करें, प्रश्न पूछें और सुविधाओं का अनुरोध करें। Couchbase के इंजीनियर रिपॉज़िटरी पर नज़र रखते हैं और यथासंभव जवाब देते हैं, लेकिन जवाब देने के समय की कोई प्रतिबद्धता नहीं है। Couchbase सहायता पोर्टल सामुदायिक उपयोग में मदद नहीं कर सकता।
- एंटरप्राइज़ सहायता — Couchbase AI Data Plane का लाइसेंस लेकर उपलब्ध है, जिसमें Couchbase Agent Memory और Couchbase Agent Catalog भी शामिल हैं। लाइसेंस प्राप्त ग्राहकों को अपने सामान्य Couchbase सहायता चैनलों के माध्यम से मदद मिलती है।
इस परियोजना का उपयोग करने और इसमें योगदान देने के लिए धन्यवाद!