Elasticsearch MCP Server by CData

elasticsearch-mcp-server-by-cdata

CData 的 Elasticsearch 模型上下文协议（MCP）服务

:heavy_exclamation_mark: 此项目构建的是本地只读 MCP 服务。如需完全远程的 MCP 访问，请查看首个托管式 MCP 平台：CData Connect AI。如需本地托管并支持完整的读取、写入、更新、删除和操作功能，以及简化的设置，请查看我们的 CData MCP Server for Elasticsearch。

目的

我们创建此只读 MCP 服务，让大模型（如 Claude Desktop）能够查询由 CData JDBC Driver for Elasticsearch 支持的 Elasticsearch 实时数据。

CData JDBC Driver 通过将 Elasticsearch 公开为关系型 SQL 模型来连接 Elasticsearch。

此服务封装了该驱动，并通过简单的 MCP 接口提供 Elasticsearch 数据，让大模型可以通过自然语言提问来检索实时信息，无需 SQL。

设置指南

1. 克隆代码库：

   git clone https://github.com/cdatasoftware/elasticsearch-mcp-server-by-cdata.git
   cd elasticsearch-mcp-server-by-cdata
   

2. 构建服务：

   mvn clean install
   

   这会生成 JAR 文件：CDataMCP-jar-with-dependencies.jar
3. 下载并安装适用于 {source} 的 CData JDBC Driver：https://www.cdata.com/drivers/elasticsearch/download/jdbc
4. 为 CData JDBC Driver 获取许可证：
   • 转到安装目录中的 lib 文件夹，通常为： *（Windows）C:\Program Files\CData\CData JDBC Driver for Elasticsearch\ *（Mac/Linux）/Applications/CData JDBC Driver for Elasticsearch/
   • 运行命令 java -jar cdata.jdbc.elasticsearch.jar --license
   • 输入您的姓名、电子邮箱和“TRIAL”（或您的许可证密钥）。
5. 配置与数据源的连接（以 Salesforce 为例）：

   • 运行命令 java -jar cdata.jdbc.elasticsearch.jar，打开 Connection String 工具。

     

   • 配置连接字符串，然后点击“Test Connection”

     注意： 如果数据源使用 OAuth，您需要在浏览器中进行身份验证。

   • 连接成功后，复制连接字符串以供后续使用。

6. 使用以下属性和格式为 JDBC 连接创建 .prp 文件（例如 elasticsearch.prp）：
   • Prefix — 用作所公开工具的前缀
   • ServerName — 服务的名称
   • ServerVersion — 服务的版本
   • DriverPath — JDBC 驱动 JAR 文件的完整路径
   • DriverClass — JDBC 驱动类的名称（例如 cdata.jdbc.elasticsearch.ElasticsearchDriver）
   • JdbcUrl — 用于通过 CData JDBC Driver 连接数据的 JDBC 连接字符串（从上文复制）
   • Tables — 留空以访问所有数据；否则，可明确指定要创建访问权限的表

     Prefix=elasticsearch
     ServerName=CDataElasticsearch
     ServerVersion=1.0
     DriverPath=PATH\TO\cdata.jdbc.elasticsearch.jar
     DriverClass=cdata.jdbc.elasticsearch.ElasticsearchDriver
     JdbcUrl=jdbc:elasticsearch:InitiateOAuth=GETANDREFRESH;
     Tables=
     

在 Claude Desktop 中使用服务器

1. 创建 Claude Desktop 的配置文件（ claude_desktop_config.json），以添加新的 MCP 服务，使用以下格式。如果文件已存在，请将条目添加到配置文件中的 mcpServers。

   Windows

   {
     "mcpServers": {
       "{classname_dash}": {
         "command": "PATH\\TO\\java.exe",
         "args": [
           "-jar",
           "PATH\\TO\\CDataMCP-jar-with-dependencies.jar",
           "PATH\\TO\\elasticsearch.prp"
         ]
       },
       ...
     }
   }
   

   Linux/Mac

   {
     "mcpServers": {
       "{classname_dash}": {
         "command": "/PATH/TO/java",
         "args": [
           "-jar",
           "/PATH/TO/CDataMCP-jar-with-dependencies.jar",
           "/PATH/TO/elasticsearch.prp"
         ]
       },
       ...
     }
   }
   

   如有需要，请将配置文件复制到相应目录（以 Claude Desktop 为例）。 Windows

   cp C:\PATH\TO\claude_desktop_config.json %APPDATA%\Claude\claude_desktop_config.json
   

   Linux/Mac

   cp /PATH/TO/claude_desktop_config.json /Users/{user}/Library/Application\ Support/Claude/claude_desktop_config.json'
   

2. 运行或刷新客户端（Claude Desktop）。

Note: 你可能需要完全退出 Claude Desktop 客户端，然后重新打开，MCP 服务才会显示。

运行服务器

1. 运行以下命令以单独启动 MCP 服务

   java -jar /PATH/TO/CDataMCP-jar-with-dependencies.jar /PATH/TO/Salesforce.prp
   

Note: 服务器使用 stdio，因此只能与运行在同一台机器上的客户端搭配使用。

使用详情

配置好 MCP 服务后，AI 客户端便可以使用内置工具读取、写入、更新和删除底层数据。通常，你无需显式调用这些工具。只需让客户端回答有关底层数据系统的问题即可。例如：

• “已赢单的商机与客户行业之间有什么关联？”
• “SUPPORT 项目中有多少个未解决的工单？”
• “你能告诉我今天有哪些日历事件吗？”

以下是可用工具列表及其说明：

工具与说明

在以下定义中，{servername} 指配置文件中 MCP 服务的名称（例如上文的 {classname_dash}）。

• {servername}_get_tables - 获取数据源中可用表的列表。使用 {servername}_get_columns 工具可以列出表中的可用列。工具输出将采用 CSV 格式，第一行包含列标题。
• {servername}_get_columns - 获取表中的列列表。使用 {servername}_get_tables 工具可以获取可用表的列表。工具输出将采用 CSV 格式，第一行包含列标题。
• {servername}_run_query - 执行 SQL SELECT 查询

JSON-RPC 请求示例

如果你要编写脚本来发送请求到 MCP 服务，而不是使用 AI 客户端（例如 Claude），则可以在调用可用工具时参考以下 JSON 负载示例，这些示例遵循 JSON-RPC 2.0 规范。

elasticsearch_get_tables

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
        "name": "elasticsearch_get_tables",
        "arguments": {}
    }
}

elasticsearch_get_columns

{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/call",
    "params": {
        "name": "elasticsearch_get_columns",
        "arguments": {
            "table":  "Account"
        }
    }
}

elasticsearch_run_query

{
    "jsonrpc": "2.0",
    "id": 3,
    "method": "tools/call",
    "params": {
        "name": "elasticsearch_run_query",
        "arguments": {
            "sql":  "SELECT * FROM [Account] WHERE [IsDeleted] = true"
        }
    }
}

故障排除

1. 如果在 Claude Desktop 中看不到 CData MCP Server，请确保已完全退出 Claude Desktop（Windows：使用任务管理器；Mac：使用活动监视器）。
2. 如果 Claude Desktop 无法检索数据，请确保已正确配置连接。使用连接字符串生成器创建连接字符串（见上文），并将连接字符串复制到属性（.prp）文件中。
3. 如果连接数据源时遇到问题，请联系 CData 支持团队。
4. 如果使用 MCP 服务时遇到问题，或有任何其他反馈，请加入 CData 社区。

许可证

此 MCP 服务采用 MIT 许可证。这意味着您可以自由使用、修改和分发此软件，但须遵守 MIT 许可证的条款和条件。详情请参阅项目仓库中的 LICENSE 文件。

所有支持的数据源

Access	Act CRM	Act-On	Active Directory
ActiveCampaign	Acumatica	Adobe Analytics	Adobe Commerce
ADP	Airtable	AlloyDB	Amazon Athena
Amazon DynamoDB	Amazon Marketplace	Amazon S3	Asana
Authorize.Net	Avalara AvaTax	Avro	Azure Active Directory
Azure Analysis Services	Azure Data Catalog	Azure Data Lake Storage	Azure DevOps
Azure Synapse	Azure Table	Basecamp	BigCommerce
BigQuery	Bing Ads	Bing Search	Bitbucket
Blackbaud FE NXT	Box	Bullhorn CRM	Cassandra
Certinia	Cloudant	CockroachDB	Confluence
Cosmos DB	Couchbase	CouchDB	CSV
Cvent	Databricks	DB2	DocuSign
Dropbox	Dynamics 365	Dynamics 365 Business Central	Dynamics CRM
Dynamics GP	Dynamics NAV	eBay	eBay Analytics
Elasticsearch	电子邮件	EnterpriseDB	Epicor Kinetic
Exact Online	Excel	Excel Online	Facebook
Facebook Ads	FHIR	Freshdesk	FTP
GitHub	Gmail	Google Ad Manager	Google Ads
Google Analytics	Google Calendar	Google Campaign Manager 360	Google Cloud Storage
Google Contacts	Google Data Catalog	Google Directory	Google Drive
Google Search	Google Sheets	Google Spanner	GraphQL
Greenhouse	Greenplum	HarperDB	HBase
HCL Domino	HDFS	Highrise	Hive
HubDB	HubSpot	IBM Cloud Data Engine	IBM Cloud Object Storage
IBM Informix	Impala	Instagram	JDBC-ODBC Bridge
Jira	Jira Assets	Jira Service Management	JSON
Kafka	Kintone	LDAP	LinkedIn
LinkedIn Ads	MailChimp	MariaDB	Marketo
MarkLogic	Microsoft Dataverse	Microsoft Entra ID	Microsoft Exchange
Microsoft OneDrive	Microsoft Planner	Microsoft Project	Microsoft Teams
Monday.com	MongoDB	MYOB AccountRight	MySQL
nCino	Neo4J	NetSuite	OData
Odoo	Office 365	Okta	OneNote
Oracle	Oracle Eloqua	Oracle Financials Cloud	Oracle HCM Cloud
Oracle Sales	Oracle SCM	Oracle Service Cloud	Outreach.io
Parquet	Paylocity	PayPal	Phoenix
PingOne	Pinterest	Pipedrive	PostgreSQL
Power BI XMLA	Presto	Quickbase	QuickBooks
QuickBooks Online	QuickBooks Time	Raisers Edge NXT	Reckon
Reckon Accounts Hosted	Redis	Redshift	REST
RSS	Sage 200	Sage 300	Sage 50 UK
Sage Cloud Accounting	Sage Intacct	Salesforce	Salesforce Data Cloud
Salesforce Financial Service Cloud	Salesforce Marketing	Salesforce Marketing Cloud Account Engagement	Salesforce Pardot
Salesloft	SAP	SAP Ariba Procurement	SAP Ariba Source
SAP Business One	SAP BusinessObjects BI	SAP ByDesign	SAP Concur
SAP Fieldglass	SAP HANA	SAP HANA XS Advanced	SAP Hybris C4C
SAP Netweaver Gateway	SAP SuccessFactors	SAS Data Sets	SAS xpt
SendGrid	ServiceNow	SFTP	SharePoint
SharePoint Excel Services	ShipStation	Shopify	SingleStore
Slack	Smartsheet	Snapchat Ads	Snowflake
Spark	Splunk	SQL Analysis Services	SQL Server
Square	Stripe	Sugar CRM	SuiteCRM
SurveyMonkey	Sybase	Sybase IQ	Tableau CRM Analytics
Tally	TaxJar	Teradata	Tier1
TigerGraph	Trello	Trino	Twilio
Twitter	Twitter Ads	Veeva CRM	Veeva Vault
Wave Financial	WooCommerce	WordPress	Workday
xBase	Xero	XML	YouTube Analytics
Zendesk	Zoho Books	Zoho Creator	Zoho CRM
Zoho Inventory	Zoho Projects	Zuora	……还有数十种