article
README
🚀 Connpass 用户 MCP 服务器
这是一个用于获取 Connpass 用户信息、参加活动信息等的 Model Context Protocol (MCP) 服务器。它能帮助你便捷地从 Connpass 平台获取所需数据。
🚀 快速开始
🔧 设置
- (若已有 Connpass API 密钥,可跳过此步)请申请一个 Connpass API 密钥。有关详细信息,请参阅 connpass 的 API 使用指南。
- 克隆此仓库。
- 配置必要的环境变量。将
.env.example复制为.env,并在其中设置 Connpass API 密钥。
cp .env.example .env
# 编辑 .env 文件并设置 CONNPASS_API_KEY
- 启动服务器,可根据需求选择以下方式:
使用 Deno 启动(推荐)
"connpass-user-mcp-server": {
"command": "wsl.exe",
"args": [
"/home/user/.deno/bin/deno",
"--allow-net=connpass.com",
"--env-file=/home/user/connpass-mcp-server/.env",
"--allow-read",
"--allow-env",
"/home/user/connpass-mcp-server/index.ts"
]
}
使用 Node.js 启动
- 安装启动 MCP 服务器所需的依赖项:
npm ci
- 构建 TypeScript 文件:
npm run build
- 在 MCP 客户端的配置文件中指定构建后的文件:
"connpass-user-mcp-server": {
"command": "wsl.exe",
"args": [
"/home/user/.local/share/mise/installs/node/20240116-5f97b4-linux-x64/bin/node",
"/home/user/connpass-mcp-server/out/index.js"
]
}
使用 Docker 启动
将项目添加到 Dockerfile 并构建:
# 假设 Dockerfile 内容如下:
FROM node:20
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
CMD ["node", "out/index.js"]
然后构建镜像并运行容器:
docker build -t connpass-mcp-server .
docker run --env-file .env connpass-mcp-server
✨ 主要特性
获取用户信息
/api/users:返回所有用户的详细信息。/api/users/${username}:返回指定用户名的详细信息。
获取用户活动
/api/users/${username}/events:返回指定用户参加的所有活动。/api/users/${username}/presentations:返回指定用户作为演讲者的活动。
💻 使用示例
示例提示词
您可以将以下提示传递给 LLM:
- “yamanoku, 请告诉我 okuto_oyama 的 Connpass 用户信息。”
- “yamanoku,请分享你参加的 Connpass 活动信息。”
- “yamanoku,请列出你作为演讲者参与的 Connpass 活动。”
- “yamanoku,请显示你的 Connpass 所属小组列表。”
📦 安装指南
使用 Deno 进行测试
运行 Connpass API 的集成测试:
deno task test
📄 许可证
🙏 致谢
感谢 GPT - 4o Image Generation 为该项目制作的徽标,以及 Claude 3.7 Sonnet 在实现过程中提供的帮助和文档示例。
Scan to join WeChat group