# MCP Vector Search Documentation

CLI-first semantic code search with MCP integration and interactive D3.js visualization for exploring code relationships.

## Quick Start

```bash
pip install mcp-vector-search
mcp-vector-search install
mcp-vector-search search "authentication logic"
```

## Documentation Sections

| Section | Description |
|---------|-------------|
| [Getting Started](./getting-started/README.md) | Installation, configuration, and first steps |
| [Guides](./guides/README.md) | How-to guides for common workflows |
| [Reference](./reference/README.md) | CLI commands, API, and technical specifications |
| [Features](./features/README.md) | Feature documentation |
| [Performance](./performance/README.md) | Optimization work and benchmarks |
| [Architecture](./architecture/README.md) | System architecture and design |
| [Development](./development/README.md) | Contributing, implementation details, and sprint docs |
| [Bug Fixes](./bug-fixes/README.md) | Bug fix documentation |
| [Research](./research/README.md) | Research notes and investigations |
| [Reports](./reports/README.md) | Assessment and remediation reports |
| [QA](./qa/README.md) | Quality assurance verification reports |
| [Deployment](./deployment/README.md) | Release process and distribution |
| [Advanced](./advanced/README.md) | Troubleshooting and advanced topics |
| [Examples](./examples/README.md) | Usage examples and sample outputs |
| [Internal](./internal/README.md) | Internal analysis and development history |
| [Tools](./tools/README.md) | MCP tool documentation |

## Key Documents

### For New Users
- [Installation Guide](./getting-started/installation.md) — Install mcp-vector-search
- [First Steps](./getting-started/first-steps.md) — Your first semantic search
- [CLI Features](./guides/cli-usage.md) — Command-line overview
- [MCP Integration](./guides/mcp-integration.md) — Integrate with Claude Desktop, Cursor, and more

### For Developers
- [Contributing Guide](./development/contributing.md) — How to contribute
- [Technical Architecture Guide](./development/architecture.md) — System design deep dive
- [Internal API Reference](./development/api.md) — Internal module APIs
- [Development Setup](./development/setup.md) — Development environment setup

### Performance and Backend
- [LanceDB Backend](./development/LANCEDB_BACKEND.md) — Default vector database documentation
- [Performance Optimizations](./performance/README.md) — Optimization work and results
- [Troubleshooting](./advanced/troubleshooting.md) — Common issues and solutions

## Documentation Standards

See [DOCUMENTATION-STANDARDS.md](./DOCUMENTATION-STANDARDS.md) for conventions used in this documentation.
