README
🚀 MCP 介绍
本仓库包含实验性的 Model Context Protocol (MCP) 服务器,该服务器用于与 Algolia API 进行交互。这是我们分享给您用于探索和实验的项目。您可以随意使用、复刻或在此基础上进行开发。不过请注意,它并非由 Algolia 官方支持,也不在我们的服务级别协议(SLA)覆盖范围内。我们可能会对其进行更新、修改或完全删除。如果您进行了自定义或配置,可能会丢失相关工作。此外,在生产环境中使用 MCP 可能会影响您的 Algolia 使用体验。
若您有任何反馈、想法(甚至代码),我们都非常乐意倾听。需要明确的是,出于 SLA 目的,MCP 并不被视为“API 客户端”。
🚀 快速开始
此项目主要是一个实验性的 MCP 服务器,用于与 Algolia API 交互,为开发者提供探索和实验的平台。
📦 安装指南
初始安装
首先,请按照 快速入门 指导进行操作,该指南会帮助您安装 Claude Desktop 并设置一个文件服务器 MCP 服务器。这是很好的入门介绍,能辅助您使用官方指南调试问题。
设置原型 Algolia MCP 服务器
需求
- Go(https://go.dev/doc/install)
克隆仓库并构建服务器
克隆仓库,并构建 mcp 服务器:
$ git clone git@github.com:algolia/mcp.git
$ cd mcp/cmd/mcp
$ go build
我们需要找到构建好的服务器二进制文件的完整路径:
$ pwd
/path/to/the/repo/cmd/mcp
⚠️ 重要提示
当将此命令添加到配置时,必须指定二进制文件及其路径(
/path/to/the/repo/cmd/mcp/mcp)。
更新设置以指向新服务器
在 Claude Desktop 中编辑设置,如 此处 所示,并在此时添加 Algolia 服务器定义(使用前面找到的二进制文件路径)。设置如下:
{
"mcpServers": {
"algolia": {
"command": "/path/to/the/repo/cmd/mcp/mcp",
"env": {
"ALGOLIA_APP_ID": "<APP_ID>",
"ALGOLIA_API_KEY": "<API_KEY>",
"ALGOLIA_INDEX_NAME": "<INDEX_NAME>"
}
}
}
}
请将 <APP_ID>、<API_KEY> 和 <INDEX_NAME> 替换为您自己的 Algolia 应用 ID、API Key 和索引名称。
启动 MCP 服务器
在终端中启动 MCP 服务器:
$ go run mcp.go
这将启动一个暴露 /search, /add, /update 和其他相关端点的服务器,您可以使用这些端点与 Algolia 索引交互。
💻 使用示例
调试操作
要验证服务器是否正常运行,请尝试以下命令:
# 搜索操作
curl -X GET "http://localhost:8080/search?q=running"
# 添加文档
curl -X POST "http://localhost:8080/add" \
--header 'Content-Type: application/json' \
--data-raw '{"body":"This is a test document", "title":"Test Document"}'
# 更新文档
curl -X PUT "http://localhost:8080/update/123" \
--header 'Content-Type: application/json' \
--data-raw '{"body":"Updated test document", "title":"Updated Test Document"}'
📚 详细文档
常见问题解答
我可以对安装的 MCP 执行哪些操作?
以下是一些示例提示,以激发您的想象力:
- “搜索品牌为‘Nike’且价格低于 100 的所有产品。”
- “将此 JSON 对象添加到博客文章索引中。”
- “更新食谱索引的可搜索属性以包含配料。”
- “配置我的索引,使 nebula_award 获奖者排名更高。”
我可以在何处阅读更多关于 Algolia MCP 服务器的信息?
查看 这篇博文,其中包括一个嵌入的演示视频。
资源模板和根当前不被 Claude Desktop 支持
这是一个奇怪的问题,因为有很多在线内容显示模板,可能只是还没有正式发布。
微信扫一扫