README
🚀 MCP 服务器 - IndexNow 索引服务
这是一个支持模型上下文协议(MCP)的服务器,主要用于通过 IndexNow 提交 URL 更新事件。默认使用 IndexNow 的主 API 端点 https://api.indexnow.org/indexnow 提交事件,同时支持自定义端点和行为。
🚀 快速开始
此服务器支持模型上下文协议(MCP),借助 IndexNow 提交 URL 更新事件。默认采用 IndexNow 主 API 端点 https://api.indexnow.org/indexnow 提交事件,也能进行自定义配置。
✨ 主要特性
- 支持单个和多个 URL 提交。
- 支持通过可选的环境变量进行配置:
INDEXNOW_API_BASE:可自定义 API 端点。INDEXNOW_KEY_LOCATION:可自定义密钥文件的位置。INDEXNOW_API_TIMEOUT:能够设置请求超时时间(默认为 30 秒)。
- 提供详细的日志输出和完善的错误处理机制。
📦 安装指南
使用 uvx 安装
uvx install gh:zizzfizzix/mcp-server-indexnow
手动安装
-
克隆仓库:
git clone https://github.com/zizzfizzix/mcp-server-indexnow.git cd mcp-server-indexnow -
安装依赖:
make install -
启动服务器:
make start
📚 详细文档
配置
示例配置文件
{
"api_base": "https://api.indexnow.org/indexnow",
"key_location": "/indexnow_key.txt",
"timeout": 30000,
"verbose": true
}
环境变量配置
| 属性 | 详情 |
|------|------|
| 环境变量名 | 类型、默认值及描述 |
| INDEXNOW_API_BASE | 字符串类型,默认值为 https://api.indexnow.org/indexnow,表示 IndexNow API 端点 |
| INDEXNOW_KEY_LOCATION | 字符串类型,默认值为 /indexnow_key.txt,表示密钥文件的路径 |
| INDEXNOW_API_TIMEOUT | 数字类型,默认值为 30000,代表请求超时时间(毫秒) |
💻 使用示例
基础用法
提交单个 URL
make submit-url URL="https://example.com/updated-page" KEY="your-indexnow-key"
高级用法
提交多个 URL
make submit-urls URLs="['https://example.com/page1', 'https://example.com/page2']" KEY="your-indexnow-key"
🔧 技术细节
开发与调试
运行测试
make test
启动调试模式
make debug
查看日志
make logs
📄 许可证
mcp-server-indexnow 采用 MIT 协议开源。你可以自由使用、修改和分发该软件,但需遵守 MIT 许可证的条款和条件。更多详细信息,请参阅项目仓库中的 LICENSE 文件。
⚠️ 重要提示
使用该服务器时请确保你拥有合法的 IndexNow API 使用权限,并且严格遵守 IndexNow 的服务条款和使用规范。
Scan to join WeChat group