# Company Docs MCP Server

A remote MCP (Model Context Protocol) server that provides AI assistants with read-only access to your company's GitHub repositories, documentation, and code examples.

## Features

- 🔍 **Search Code** — Find code examples across all indexed repositories
- 📄 **Get Files** — Retrieve full file contents
- 📚 **Search Docs** — Search documentation files and READMEs
- 🗂️ **Browse Repos** — Navigate repository structure
- 🔐 **Read-Only Access** — Safe, no write operations

---

## Quick Start

### 1. Get Access

Contact your administrator for an **API key**.

### 2. Configure Your MCP Client

Add this to your MCP client configuration (e.g., Claude Desktop `claude_desktop_config.json`):

```json
{
  "mcpServers": {
    "company-docs": {
      "url": "https://mcpserverpoc-production.up.railway.app/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}
```

Replace `YOUR_API_KEY` with the key provided by your administrator.

### 3. Start Using It

Once configured, you can ask your AI assistant things like:

- *"Search our codebase for authentication examples"*
- *"Show me the README from our design-system repo"*
- *"Find React components in the shared-components repo"*
- *"Get the content of src/utils/api.ts from internal-api"*
- *"Browse the docs folder in our platform-core repo"*
- *"Search our documentation for deployment guides"*

---

## Available Tools

### `search_code`

Search for code across repositories.

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | ✅ | Search query (e.g., `"authentication middleware"`) |
| `repos` | string[] | ❌ | Specific repositories to search |

### `get_file`

Get full file content from a repository.

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repo` | string | ✅ | Repository name |
| `path` | string | ✅ | File path (e.g., `"src/components/Button.tsx"`) |

### `search_docs`

Search documentation files (READMEs, docs folders).

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | ✅ | Documentation search query |

### `get_readme`

Get the README.md from a repository.

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repo` | string | ✅ | Repository name |

### `list_repos`

List all indexed repositories. No parameters required.

### `browse_repo`

Browse the file structure of a repository.

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repo` | string | ✅ | Repository name |
| `path` | string | ❌ | Path within repository (empty for root) |

---

### "Rate limit exceeded"

- GitHub API has rate limits (5000 requests/hour)
- Wait a few minutes and try again

---

## Security

| | |
|---|---|
| ✅ | Read-only access (no write operations) |
| ✅ | API key authentication required |
| ✅ | All requests are logged |
| ⚠️ | Keep your API key private — don't share it |

---

## Support

Contact your administrator if you need help or have questions.