README
🚀 MCP Fathom Analytics 服务器
这是一个非官方的 Model Context Protocol(MCP)服务器实现,可借助 AI 助手访问 Fathom Analytics 数据。本实现运用 @mackenly/fathom-api 这个非官方 SDK 与 Fathom Analytics API 进行交互。需要注意的是,本项目未获得、未经或未由 Fathom Analytics 背书支持。目前,此项目已作为 npm 上的 npx 脚本 发布。
🚀 快速开始
如果您使用的是 Claude Desktop,可以在其中添加该 MCP 服务器,方式为使用 json 配置(更多信息请参见 快速入门指南)。以下是一个示例:
{
"mcpServers": {
"fathom-analytics": {
"command": "npx",
"args": [
"-y",
"mcp-fathom-analytics"
],
"env": {
"FATHOM_API_KEY": "your_api_key_here"
}
}
}
}
您可以在 Model Context Protocol 示例客户端 找到更多其他 MCP 客户端的信息。
✨ 主要特性
该 MCP 服务器提供了以下 Fathom Analytics 工具:
账户信息
get-account:获取您的 Fathom Analytics 账户详情
网站管理
list-sites:列出您所有的 Fathom Analytics 网站
事件
list-events:为特定网站列出事件
分析
get-aggregation:生成带有灵活过滤和分组选项的聚合分析报告
访客跟踪
get-current-visitors:获取有关当前网站访客的实时数据
📚 详细文档
API 结构
该 MCP 服务器使用 @mackenly/fathom-api SDK 接口与 Fathom Analytics 的以下 API 端点进行交互:
- 账户 API:
https://api.usefathom.com/v1/account - 网站 API:
https://api.usefathom.com/v1/sites - 事件 API:
https://api.usefathom.com/v1/sites/SITE_ID/events - 聚合 API:
https://api.usefathom.com/v1/aggregations - 当前访客 API:
https://api.usefathom.com/v1/current_visitors
聚合示例
聚合工具非常灵活,以下是几个示例用法:
基础用法
过去 30 天的每日页面浏览量统计:
{
"entity": "pageview",
"entity_id": "SITE_ID",
"aggregates": "pageviews,uniques,visits",
"date_grouping": "day",
"date_from": "2023-08-01 00:00:00"
}
高级用法
具体页面的性能:
{
"entity": "pageview",
"entity_id": "SITE_ID",
"aggregates": "pageviews,uniques,avg_duration",
"field_grouping": "pathname",
"sort_by": "pageviews:desc",
"limit": 5
}
来自特定国家的流量:
{
"entity": "event",
"entity_id": "SITE_ID",
"aggregates": "count",
"field_grouping": "geo.country_code",
"filter": {
"properties": {
"event_type": "page_view"
}
}
}
🤝 贡献
欢迎为该项目做出贡献!请参考 CONTRIBUTING.md 了解如何参与。
📄 许可证
此项目遵循 MIT 许可证。更多信息请参见 LICENSE。
📞 联系方式
如有任何问题或反馈,请联系 联系方式。
微信扫一扫