Apm MCP Server

🚀 敏捷实践地图 MCP 服务器

这是一个用于与敏捷实践地图（Agile Practice Map）数据进行交互的MCP服务器，借助大型语言模型从敏捷实践地图的知识库中检索信息，为用户提供敏捷实践相关的知识支持。

参考链接

🚀 快速开始

本服务器提供了与敏捷实践地图数据交互的功能，可通过相关工具进行信息查询和实践名称获取等操作。同时，还提供了数据库构建工具，方便用户创建和扩展知识库。

✨ 主要特性

• 信息检索：通过大型语言模型从敏捷实践地图的知识库中检索信息。
• 工具丰富：提供 query_apm 和 list_apm_practices 等工具，方便用户与敏捷实践地图数据进行交互。
• 资源获取：可通过 resource://{practice_name}/url 获取指定实践名称的 URL 信息。
• 数据库构建：提供数据库构建工具，可从内容 URL 或文本文件中构建向量数据库。

📦 安装指南

安装 uv

如果尚未安装，需要先通过包管理器安装 uv。

• Windows：

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

• macOS：

curl -LsSf https://astral.sh/uv/install.sh | sh

• Linux：

curl -LsSf https://astral.sh/uv/install.sh | sh

克隆仓库

# 克隆仓库
git clone https://github.com/HappymanOkajima/apm-mcp-server.git

OpenAI API 密钥的设置

在 apm-mcp-server 目录下创建一个 .env 文件。 .env 文件示例：

OPENAI_API_KEY=your_api_key_here

💻 使用示例

基础用法

query_apm

# 回答与敏捷实践地图相关的问题
# 输入:
#   question (字符串): 用户关于敏捷实践的提问
# 输出: 基于敏捷实践地图知识库的回答

list_apm_practices

# 获取敏捷实践地图中包含的所有实践名称列表
# 输入: 无
# 输出: 实践名称列表

resource://{practice_name}/url

# 返回指定实践名称的URL信息
# 输入:
#   practice_name (字符串): 实践名称（例如："daily-scrum"）
# 输出: 包含实践名称和URL的信息 { "practice_name": ..., "url": ... }

高级用法

数据库构建

# 运行以下命令构建向量数据库
uv run -m tools.populate_db

运行此命令将生成 data/chroma_db/ 目录下的向量数据库，可用于从 Web 页面或文本文件创建和扩展知识库。

📚 详细文档

项目结构

• data 目录：包含构建好的向量数据库文件。
• tools 目录：提供一些实用脚本，用于从源数据构建向量数据库。

数据库

为了方便配置，默认在 data 目录下存储了基于敏捷实践地图信息的 ChromaDB 数据库文件。

🔧 技术细节

本项目通过大型语言模型从敏捷实践地图的知识库中检索信息，使用 ChromaDB 存储基于敏捷实践地图信息的数据库文件。同时，提供了相关工具和脚本，方便用户与数据库进行交互和构建。

📄 许可证

该 MCP 服务器基于 MIT 许可证发布。根据许可条款，您可以在遵守条件的情况下自由使用、修改和分发软件。更多详情请参阅项目仓库中的 LICENSE 文件。