README
🚀 Qiita MCP 服务器
Qiita MCP 服务器是一个用于与工程师知识共享平台 Qiita 交互的模型上下文协议(MCP)服务器,它允许 AI 代理通过标准化的 MCP 工具与 Qiita API 进行交互,实现文章的创建、读取和更新等操作。
🚀 快速开始
此包提供了一个实现 MCP 规范的服务器,允许 AI 代理通过标准化的 MCP 工具与 Qiita API 进行交互,支持创建、读取和更新 Qiita 上的文章。MCP 是一个开放协议,用于构建可以使用外部工具和服务的 AI 代理,此服务器实现了 MCP 规范,提供了用于处理 Qiita 内容的工具。
✨ 主要特性
该服务器提供了一系列 MCP 工具,具体如下:
| 工具名称 | 描述 |
|----------|------|
| get_my_qiita_articles | 获取当前已认证用户的 Qiita 文章 |
| get_qiita_item | 通过 ID 获取特定的 Qiita 文章 |
| post_qiita_article | 在 Qiita 上创建新文章 |
| update_qiita_article | 更新现有的 Qiita 文章 |
| get_qiita_markdown_rules | 获取 Qiita Markdown 格式规则和快捷键说明 |
📦 安装指南
先决条件
- Node.js(>=20.0.0)
- 带有 API 访问令牌的 Qiita 账户
- 可通过以下链接生成 Qiita API 令牌:https://qiita.com/settings/tokens/new
在 VS Code 中使用
- 在项目中创建一个
.vscode/mcp.json文件,内容如下:
{
"inputs": [
{
"type": "promptString",
"id": "qiita-api-token",
"description": "Qiita API Token",
"password": true
}
],
"servers": {
"qiita-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["@2bo/qiita-mcp-server"],
"env": {
"QIITA_API_TOKEN": "${input:qiita-api-token}"
}
}
}
}
💻 使用示例
基础用法
在 VS Code 中使用时,按照上述步骤创建 .vscode/mcp.json 文件后,即可利用服务器提供的 MCP 工具与 Qiita API 进行交互。例如,若要获取当前已认证用户的 Qiita 文章,可在合适的环境中调用 get_my_qiita_articles 工具。
🔧 技术细节
开发设置
- 克隆仓库:
git clone https://github.com/2bo/qiita-mcp-server.git
cd qiita-mcp-server
- 安装依赖项:
npm install
- 配置环境:
npm run dev- 开发模式下运行 TypeScript 且带有热重载npm run build- 构建项目npm run prepare- 准备发布包
贡献
欢迎贡献!请随时提交 Pull Request。
📄 许可证
本项目使用 MIT 许可证,详情请参阅 LICENSE 文件。
Scan to contact