CorpusIQ Documentation

Complete documentation for the CorpusIQ Apps SDK MCP Server.

📚 Documentation Index

Getting Started

Perfect for new users who want to get up and running quickly.

Decision Making

For evaluating whether CorpusIQ is right for you.

Technical Reference

For developers and system administrators.

Operations

For deploying and maintaining CorpusIQ in production.

🎯 Reading Paths

I’m a First-Time User

1. Start with Quick Start (5 min)
2. Explore Use Cases to see what’s possible (10 min)
3. Read User Guide sections as needed (30 min)
4. Bookmark FAQ and Troubleshooting for reference

Total time: ~45 minutes to become productive

I’m Evaluating CorpusIQ

1. Read Why MCP? to understand the technology (10 min)
2. Review Why CorpusIQ? for product comparison (15 min)
3. Check Use Cases for ROI and examples (15 min)
4. Skim User Guide to understand capabilities (10 min)
5. Review Security Policy for compliance (10 min)

Total time: ~60 minutes for informed decision

I’m a Developer

1. Quick Start Quick Start to try it locally (5 min)
2. Review Architecture to understand the system (20 min)
3. Study API Reference for integration details (30 min)
4. Read Best Practices for development guidelines (20 min)
5. Reference Troubleshooting as needed

Total time: ~75 minutes to start developing

I’m Deploying to Production

1. Ensure you’ve completed local setup (Quick Start)
2. Read Security Policy completely (15 min)
3. Follow Deployment Guide step-by-step (60 min)
4. Review Best Practices operations section (15 min)
5. Bookmark Troubleshooting for ongoing support

Total time: ~90 minutes + deployment time

I’m Contributing

1. Set up development environment (Quick Start)
2. Read Architecture to understand the codebase (20 min)
3. Study Best Practices development section (15 min)
4. Check API Reference for technical details (as needed)
5. Review Contributing Guidelines

Total time: ~35 minutes before first contribution

📖 Document Details

User Guide (15,000 words)

What’s covered:

• Installation and setup
• Core concepts (MCP, tools, widgets)
• Using CorpusIQ (search, connectors)
• Advanced features
• Configuration
• Security

Best for: New users, reference, comprehensive understanding

API Reference (15,000 words)

What’s covered:

• HTTP endpoints
• MCP protocol details
• Tool specifications
• Data models
• Error codes
• Examples

Best for: Developers, integration, troubleshooting

Why MCP (10,000 words)

What’s covered:

• The problem with fragmented data
• What is MCP and why it matters
• Benefits for users, developers, enterprises
• MCP vs traditional integrations
• Getting started with MCP

Best for: Understanding the technology, making the case for MCP

Why CorpusIQ (14,000 words)

What’s covered:

• What makes CorpusIQ special
• Comparisons with alternatives
• Real user testimonials
• Technical excellence
• Getting started

Best for: Product evaluation, competitive analysis

Use Cases (18,000 words)

What’s covered:

• Individual user scenarios
• Small team examples
• Development team use cases
• Enterprise deployments
• Industry-specific applications
• Role-specific scenarios
• ROI calculations

Best for: Understanding practical applications, calculating value

Architecture (18,000 words)

What’s covered:

• High-level architecture
• Component details
• Data flows
• Security architecture
• Scalability patterns
• Performance optimization

Best for: Understanding system design, technical decisions

Best Practices (18,000 words)

What’s covered:

• Search optimization
• Connector management
• Security practices
• Performance tuning
• Deployment strategies
• Development guidelines
• Team collaboration
• Operations and maintenance

Best for: Optimal usage, avoiding pitfalls, professional deployment

FAQ (13,000 words)

What’s covered:

• General questions
• Installation and setup
• Usage questions
• Technical details
• Security and privacy
• Deployment and production
• Troubleshooting basics

Best for: Quick answers, common questions

Troubleshooting (17,000 words)

What’s covered:

• Quick diagnostics
• Installation issues
• Server problems
• Connection issues
• Search problems
• Connector issues
• Authentication failures
• Performance problems
• Debugging techniques

Best for: Solving problems, diagnosing issues

🔍 Find What You Need

By Topic

Installation & Setup

• Quick Start
• User Guide - Getting Started
• FAQ - Installation
• Troubleshooting - Installation

Using CorpusIQ

• User Guide - Using CorpusIQ
• Best Practices - Search
• Use Cases

Connectors

• User Guide - Managing Connectors
• Best Practices - Connectors
• Troubleshooting - Connectors

Security

• Security Policy
• User Guide - Security
• Best Practices - Security
• Deployment - OAuth

Deployment

• Deployment Guide
• Best Practices - Deployment
• Architecture - Deployment

Development

• Architecture
• API Reference
• Best Practices - Development

Troubleshooting

• Troubleshooting Guide
• FAQ
• Best Practices - Common Pitfalls

💬 Get Help

Can’t find what you’re looking for?

1. Search the docs: Use Ctrl+F or Cmd+F to search within documents
2. Check the FAQ: FAQ.md has 100+ questions answered
3. Troubleshooting guide: TROUBLESHOOTING.md has detailed solutions
4. GitHub Issues: Search existing issues
5. Discussions: Ask the community

🤝 Contributing to Docs

Found an error? Want to improve the documentation?

• Typos/Errors: Open an issue
• Improvements: Submit a PR
• New content: Start a discussion

All documentation is written in Markdown and stored in the docs/ directory.

📊 Documentation Stats

• Total documents: 9 comprehensive guides
• Total words: ~120,000+ words
• Total pages: ~300+ pages (if printed)
• Coverage: Installation, usage, development, deployment, troubleshooting
• Maintenance: Actively maintained and updated with each release

Last Updated: January 2026
Version: 0.1.0

Start reading: Choose your path above or jump to Quick Start!