Frequently Asked Questions
Find answers to common questions about using Docjays.
Getting Started
What is Docjays?
Docjays is a documentation management platform that helps teams organize, version control, and audit their documentation. It includes AI-powered features like automated quality checks, MCP integration with AI assistants, CLI tool for documentation management, and intelligent document assistance.
Do I need to create an account to use Docjays?
Yes, you need to create an account to use the web application. Sign up with your email address, verify it, and you can start creating projects immediately. The CLI tool can be used locally without an account, but requires an API key to sync with the web platform.
How much does Docjays cost?
Docjays offers a free tier with basic features. For advanced features like unlimited projects, team collaboration, and priority support, check our pricing page for current plans.
Can I import existing documentation?
Yes! You can create documents manually through the UI, or use the Docjays CLI tool to sync documentation from your local file system, Git repositories, or HTTP URLs.
CLI Tool
What is the Docjays CLI?
Docjays CLI is a command-line tool for managing documentation sources in your projects while keeping them separate from your main codebase. It's perfect for:
- Syncing documentation from Git repos, HTTP URLs, or local paths
- Exposing local docs to Claude via MCP
- Auto-syncing documentation at regular intervals
- Managing multiple documentation sources
- Keeping documentation out of your repository (.docjays/ is git-ignored)
See our CLI Tool Guide for complete documentation.
How do I install the CLI?
Install from npm:
npm install -g docjaysOr use without installation:
npx docjays initSee our CLI Tool Guide for detailed instructions.
Can I use the CLI with private repositories?
Yes! The CLI includes an encrypted keystore for managing credentials. Use 'docjays auth init' to set up the keystore, then 'docjays auth add' to store tokens for private repositories. All credentials are encrypted with AES-256-GCM.
Does the CLI work offline?
Yes, the CLI can work with local documentation sources without an internet connection. However, syncing from Git repos or HTTP URLs requires connectivity, and MCP integration requires the AI assistant to be running.
Projects & Documents
How many projects can I create?
The number of projects you can create depends on your plan. Free tier users can create up to 3 projects, while paid plans offer unlimited projects.
What document types are supported?
Docjays supports various document types including Architecture Docs, API Contracts, Feature Specs, User Guides, Technical Specs, ADRs (Architectural Decision Records), and more. You can also create custom document types.
Can I organize documents into folders?
Yes! Documents are organized using a file-path structure (e.g., /api/authentication.md, /guides/getting-started.md) which creates a natural folder hierarchy.
Is there a limit to document size?
Individual documents can be up to 1MB in size on the free tier, and up to 5MB on paid plans. For larger documentation needs, consider splitting content across multiple documents.
Team Collaboration
How do I invite team members?
Go to your project settings, navigate to the Members tab, and click 'Invite Member'. Enter their email address and choose their role (Owner, Editor, or Viewer). They'll receive an invitation email.
What are the different user roles?
Docjays has three user roles:
- Owner: Full access including project deletion, member management, and billing
- Editor: Can create, edit, and delete documents, create proposals, and run audits
- Viewer: Read-only access to documents and project information
How does version control work?
Docjays uses a proposal-based revision system. When you want to change a document, you create a proposal (revision), make your changes, and submit for approval. Editors and Owners can approve or reject proposals. Once approved, changes are merged into the main document.
Can I see who made changes to a document?
Yes! Each document maintains a complete revision history showing who made changes, when they were made, and what was changed. You can view this in the document's history section.
MCP Integration
What is MCP?
MCP (Model Context Protocol) is a standard for connecting AI assistants to external data sources. With Docjays' MCP integration, your AI assistant can:
- Read and search your documentation
- Answer questions based on your docs
- Propose changes to documents
- Access grounded knowledge and decisions
Which AI assistants work with Docjays?
Docjays MCP integration works with multiple AI assistants:
- Claude Desktop - Official desktop app (macOS, Windows)
- Cursor - AI code editor (all platforms)
- Windsurf - Collaborative IDE (all platforms)
- Claude Code CLI - Terminal-based assistant (all platforms)
- VS Code - With Continue extension (all platforms)
See our MCP Integration Guide for setup instructions for each assistant.
How do I set up MCP integration?
Setting up MCP integration involves a few steps:
- Generate an API key in your project settings
- Locate your AI assistant's config file
- Add Docjays configuration with your API key
- Restart your AI assistant
See our MCP Integration Guide for detailed instructions for your specific AI assistant.
Is MCP integration secure?
Yes! MCP integration uses API keys for authentication, and all communication is encrypted over HTTPS. API keys can be revoked at any time from your project settings. You control which projects your AI assistant can access by configuring specific API keys.
Can I use MCP with local documentation (CLI)?
Yes! The Docjays CLI includes built-in MCP server support. Run:
docjays serveThen configure your AI assistant to use the CLI's MCP server. This exposes your local documentation to your AI assistant without needing to upload it to the web platform.
AI Features
What AI features are available?
Docjays includes several AI-powered features:
- Document Chat: Ask questions about your documents and get AI-powered answers
- Automated Audits: Check documentation quality, consistency, and freshness
- Smart Suggestions: Get AI recommendations for improving your documentation
- MCP Integration: Connect AI assistants directly to your documentation
How do document audits work?
Document audits use AI to analyze your documentation for quality issues like outdated content, inconsistencies, missing information, unclear language, and compliance violations. You can run audits manually or schedule them to run automatically.
Is my documentation data used to train AI models?
No, your documentation is never used to train AI models. We use AI models to analyze and assist with your documentation, but your content remains private and is not shared with model providers for training purposes.
Troubleshooting
I can't see my project after creating it
Try refreshing the page. If the project still doesn't appear, check that you're logged into the correct account. If the issue persists, contact support with your account email and project name.
Why isn't my API key working?
Common reasons for API key failures:
- The API key format is incorrect (should be: dj_proj_<project-id>_<random-string>)
- The API key has been deleted or revoked
- The API key doesn't have necessary permissions
- The project URL in your configuration is incorrect
Try regenerating a new API key from project settings.
My AI assistant can't see my documentation
Check these items:
- Verify your API key is correct in the config file
- Ensure you restarted your AI assistant after updating the config
- Check that the project URL is correct and accessible
- Verify the config file JSON syntax is valid
See our MCP troubleshooting section for more details.
The CLI isn't syncing my documentation
Common CLI sync issues:
- Check that the source URL or path is correct
- For Git sources, verify you have access (use 'docjays auth' for private repos)
- Run 'docjays status' to check configuration
- Try 'docjays sync --force' to force a fresh sync
- Check logs in .docjays/logs/ for detailed error messages
How do I report a bug or request a feature?
We welcome bug reports and feature requests! You can:
- Contact support through the help widget in the app
- Email us at support@docjays.com
- Submit an issue on our GitHub repository
Still Have Questions?
Can't find the answer you're looking for? We're here to help!
Was this page helpful?