Apm MCP Server

🚀 APM-MCP Server: Agile Practice Map MCP Server

This is an MCP server designed to interact with the data from the Agile Practice Map. It retrieves information from the Agile Practice Map's knowledge base using large language models.

Reference Link

🚀 Quick Start

✨ Features

• Query and Listing Tools: The server provides two main tools, query_apm and list_apm_practices, to interact with the Agile Practice Map data.
• Resource Retrieval: It allows users to retrieve URL information for specific practices in the Agile Practice Map.
• Database Management: The server comes with database management capabilities, including installation, configuration, and database building tools.

📦 Installation

Install uv

If uv is not already installed, you need to install it via the package manager first.

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

Clone the Repository

# Clone the repository
git clone https://github.com/HappymanOkajima/apm-mcp-server.git

Set OpenAI API Key

Create a .env file in the apm-mcp-server directory.

Example of the .env file:

OPENAI_API_KEY=your_api_key_here

💻 Usage Examples

Tools

query_apm

• Function: Answer questions related to the Agile Practice Map.
• Input:
  • question (string): User's question about agile practices.
• Output: Answers based on the Agile Practice Map knowledge base.

list_apm_practices

• Function: Get a list of all practice names included in the Agile Practice Map.
• Input: None
• Output: A list of practice names.

Resources

resource://{practice_name}/url

• Function: Return the URL information of the specified practice name.
• Input:
  • practice_name (string): Practice name (e.g., "daily-scrum").
• Output: Information containing the practice name and URL { "practice_name": ..., "url": ... }

📚 Documentation

Project Structure

• data Directory: Contains the built vector database files.
• tools Directory: Provides some utility scripts for building the vector database from source data.

Database

For easy configuration, a ChromaDB database file based on the Agile Practice Map information is stored in the data directory by default.

Database Building Tool

A tool is provided to build a vector database from content URLs or text files.

Run the following command:

uv run -m tools.populate_db

This will generate the vector database in the data/chroma_db/ directory. Therefore, you can use this tool to create and expand the knowledge base from web pages or text files.

📄 License

This MCP server is released under the MIT License. Under the terms of the license, you can freely use, modify, and distribute the software while complying with the conditions. For more details, please refer to the LICENSE file in the project repository.