Skip to documentation
ProjectCtxDocs

ProjectCtx documentation

Getting started

Create an account, install the agent, connect your tools, and verify the setup.

This guide takes you from an invitation to a verified ProjectCtx connection.

Requirements

  • Node.js 22 or newer
  • npm
  • A ProjectCtx invite code from your workspace administrator
  • Git when using repository scanning
  • An authenticated Claude Code CLI when using automatic local memory

Confirm the Node.js version before installing:

node --version

Create Your Account

  1. Open projectctx.com.
  2. Activate the sign-in screen and select Have an invite code?
  3. Enter your email address and invite code.
  4. Open the secure link sent to your email address.
  5. Choose a password and complete account activation.

Invite codes grant account enrollment; they are not API credentials. Do not place an invite code in source control, documentation, issue trackers, or chat.

Install The Agent

The current public release uses npm's alpha distribution tag:

npm install -g @projectctx/agent@alpha
projectctx --help

If the command is not found, check the global npm binary directory:

npm prefix -g

Add its binary directory to PATH, then open a new terminal.

Connect Supported Clients

Preview every local configuration change before applying it:

projectctx connect --dry-run
projectctx connect

The command preserves unrelated configuration, creates backups before changing supported files, and updates its managed block instead of duplicating it.

Restart each detected client after connection. Native lifecycle hooks may ask for approval through the client's normal trust flow.

Authorize Hosted Memory

ProjectCtx's hosted MCP endpoint is:

https://projectctx.com/mcp

The first hosted memory call opens the client-owned OAuth flow. Sign in to ProjectCtx, review the requested access, and approve it.

OAuth credentials stay inside the AI client. projectctx doctor cannot inspect those credentials, so an incomplete CLI-credential check does not mean the client's OAuth connection failed.

Verify The Setup

Run local diagnostics:

projectctx doctor

Then start a new conversation in a connected AI client and ask:

Load my ProjectCtx check-in context, then summarize the projects, decisions,
and priorities you already know about me. Use ProjectCtx before searching local
session history or notes.

The exact MCP tool prefix varies by client. Hermes / Jarvis uses the mcp_project_memory_ prefix.

If the client cannot see ProjectCtx tools, continue to Troubleshooting.

Next Steps