get_server_configuration_status
Check Couchbase server status and verify configuration without establishing a connection to monitor operational health.
Instructions
Get the server status and configuration without establishing connection. This tool can be used to verify if the server is running and check the configuration.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/server.py:22-49 (handler)The handler function implementing the core logic of the 'get_server_configuration_status' tool. It retrieves and returns anonymized server configuration and connection status.
def get_server_configuration_status(ctx: Context) -> dict[str, Any]: """Get the server status and configuration without establishing connection. This tool can be used to verify if the server is running and check the configuration. """ settings = get_settings() # Don't expose sensitive information like passwords configuration = { "connection_string": settings.get("connection_string", "Not set"), "username": settings.get("username", "Not set"), "read_only_query_mode": settings.get("read_only_query_mode", True), "password_configured": bool(settings.get("password")), "ca_cert_path_configured": bool(settings.get("ca_cert_path")), "client_cert_path_configured": bool(settings.get("client_cert_path")), "client_key_path_configured": bool(settings.get("client_key_path")), } app_context = ctx.request_context.lifespan_context connection_status = { "cluster_connected": app_context.cluster is not None, } return { "server_name": MCP_SERVER_NAME, "status": "running", "configuration": configuration, "connections": connection_status, } - src/tools/__init__.py:31-39 (registration)Import of the tool handler from server.py into the tools.__init__.py for inclusion in the ALL_TOOLS list used for MCP registration.
from .server import ( get_buckets_in_cluster, get_cluster_health_and_services, get_collections_in_scope, get_scopes_and_collections_in_bucket, get_scopes_in_bucket, get_server_configuration_status, test_cluster_connection, ) - src/mcp_server.py:175-177 (registration)Loop that registers all tools from ALL_TOOLS, including 'get_server_configuration_status', to the FastMCP server instance.
# Register all tools for tool in ALL_TOOLS: mcp.add_tool(tool) - src/tools/__init__.py:42-64 (registration)The ALL_TOOLS list that includes the get_server_configuration_status tool for bulk registration in mcp_server.py.
ALL_TOOLS = [ get_buckets_in_cluster, get_server_configuration_status, test_cluster_connection, get_scopes_and_collections_in_bucket, get_collections_in_scope, get_scopes_in_bucket, get_document_by_id, upsert_document_by_id, delete_document_by_id, get_schema_for_collection, run_sql_plus_plus_query, get_index_advisor_recommendations, list_indexes, get_cluster_health_and_services, get_queries_not_selective, get_queries_not_using_covering_index, get_queries_using_primary_index, get_queries_with_large_result_count, get_queries_with_largest_response_sizes, get_longest_running_queries, get_most_frequent_queries, ] - src/mcp_server.py:13-13 (registration)Import of the ALL_TOOLS list containing the tool for registration.
from tools import ALL_TOOLS