🧠 AI Memory
📋 Distribution Guide

PyPI Publishing Setup Guide

Configure PyPI trusted publishing to enable pip install aimemory-mcp-server

⏱️ 3 minutes • 🔒 Uses GitHub Actions (no API token needed)

📊 Current Status

✅
Package Built
v1.4.0 in dist/ (11.9KB)
✅
GitHub Actions Workflow
.github/workflows/publish-pypi.yml
⏳
PyPI Trusted Publisher
Not yet configured

Setup Steps

1

Create PyPI Account (if needed)

  1. Go to pypi.org/account/register
  2. Create an account with email hello@aimemory.pro
  3. Verify your email address
  4. Enable 2FA (recommended but not required for trusted publishing)
2

Configure Trusted Publishing

  1. Go to pypi.org/manage/account/publishing
  2. Click "Add a new pending publisher"
  3. Fill in the form with these values:

PyPI Project Name: aimemory-mcp-server

Owner: jingchang0623-crypto

Repository: aimemory

Workflow name: publish-pypi.yml

Environment name: (leave blank)

3

Trigger Publishing

After trusted publishing is configured, publish by either:

Option A: Create a GitHub Release

  1. Go to GitHub repo → Releases
  2. Click "Draft a new release"
  3. Tag: v1.4.0 (or higher)
  4. Publish → Actions runs automatically

Option B: Manual Workflow Dispatch

  1. Go to repo → Actions tab
  2. Select "Publish to PyPI" workflow
  3. Click "Run workflow" button
  4. Branch: main
4

Verify Installation

After publishing succeeds, verify with:

$ pip install aimemory-mcp-server

$ aimemory-mcp-server

# Should output: "AI Memory MCP Server running on stdio..."

Troubleshooting

Error: "invalid-publisher"

The trusted publisher configuration doesn't match the GitHub Actions workflow. Double-check:

  • Owner matches exactly: jingchang0623-crypto
  • Repository matches exactly: aimemory
  • Workflow filename matches: publish-pypi.yml
  • Environment name is blank (not "production" or anything else)

Error: "project already exists"

Someone already claimed the package name on PyPI. You may need to file a name dispute or choose a different package name.

Package not showing on PyPI

PyPI may take a few minutes to index. Check the GitHub Actions run logs for errors. If it succeeded, search for "aimemory-mcp-server" on pypi.org.

Post-Publish Checklist

After PyPI publishing succeeds, update these files:

  • MCP Server page: Change "PyPI release coming soon" → "pip install aimemory-mcp-server"
  • Homepage: Update install command from GitHub URL to pip install aimemory-mcp-server
  • README.md: Add PyPI badge and update install instructions
  • Docs: Remove GitHub install fallback notes
  • GitHub Actions: Tag release as latest on GitHub
← Back to MCP Documentation|MCP Server Page →