ppm-doc

MCP server that connects to Jira and generates development documents (.md) for user stories.

Install

npm install

Usage

# Development
npm run dev

# Production
npm start

# Test
npm test

Configuration

Environment variables

Copy the template and fill your credentials:

cp .env .env.local

JIRA_URL=https://example.atlassian.net
[email protected]
JIRA_API_TOKEN=your-api-token

| Variable | Description | |---|---| | JIRA_URL | Jira instance URL (e.g. https://example.atlassian.net/) | | JIRA_EMAIL | Email for Jira Basic Auth | | JIRA_API_TOKEN | Atlassian API token | Credentials can also be passed per-tool invocation as parameters.

Git configuration

The server reads the local Git repository to detect the current branch, changed files, and open pull requests. It requires:

• A Git repository with origin remote pointing to GitHub.
• git CLI available in PATH.

Detection follows this order:

1. GitHub API — finds an open PR for the current branch and lists its changed files.
2. Local fallback — runs git diff --name-status <base>...HEAD against master/main.
3. Manual — if neither works, the document shows a placeholder.

Supported base branches: master, origin/master, main, origin/main.

Tools

| Tool | Description | |---|---| | validate_jira | Verifies Jira connectivity and credentials. | | jira_info | Fetches a user story as structured info (summary, status, assignee, context, solution). | | ppm_doc | Fetches a user story and writes a development document (.md) to docs/. | | greet | Registers a user story key for doc generation. |

License

ISC