Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
ARG DOCKER_REGISTRY

FROM ${DOCKER_REGISTRY}node:20

WORKDIR /app

# Copy everything
COPY . .

# Set CI=true to avoid interactive prompts
ENV CI=true

# Install pnpm and dependencies
RUN npm install -g pnpm \
&& pnpm install

# Build packages
RUN pnpm --filter @zilliz/claude-context-core build \
&& pnpm --filter @zilliz/claude-context-mcp build

WORKDIR /app/packages/mcp
ENTRYPOINT ["pnpm", "run", "dev:http"]
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,23 @@ Copy your Personal Key to replace `your-zilliz-cloud-api-key` in the configurati
</details>

<details>
<summary>Get OpenAI API Key for embedding model</summary>
<summary>Get an API Key for embedding model</summary>

You need an OpenAI API key for the embedding model. You can get one by signing up at [OpenAI](https://platform.openai.com/api-keys).
You need an API key for the embedding model. Claude Context supports multiple providers:

Your API key will look like this: it always starts with `sk-`.
Copy your key and use it in the configuration examples below as `your-openai-api-key`.
**Option 1: OpenAI**
- Sign up at [OpenAI](https://platform.openai.com/api-keys)
- Your API key will start with `sk-`
- Use as `your-openai-api-key` in configuration

**Option 2: Azure OpenAI**
- Use your Azure OpenAI resource endpoint and API key
- Requires deployment name instead of model name
- See [Azure OpenAI Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/)

**Option 3: Other Providers**
- VoyageAI, Gemini, or Ollama (local)
- See [Provider Configuration Guide](packages/mcp/README.md#embedding-provider-configuration) for details

</details>

Expand Down Expand Up @@ -542,8 +553,7 @@ Claude Context is a monorepo containing three main packages:
- **`@zilliz/claude-context-mcp`**: Model Context Protocol server for AI agent integration

### Supported Technologies

- **Embedding Providers**: [OpenAI](https://openai.com), [VoyageAI](https://voyageai.com), [Ollama](https://ollama.ai), [Gemini](https://gemini.google.com)
- **Embedding Providers**: [OpenAI](https://openai.com), [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service), [VoyageAI](https://voyageai.com), [Ollama](https://ollama.ai), [Gemini](https://gemini.google.com)
- **Vector Databases**: [Milvus](https://milvus.io) or [Zilliz Cloud](https://zilliz.com/cloud)(fully managed vector database as a service)
- **Code Splitters**: AST-based splitter (with automatic fallback), LangChain character-based splitter
- **Languages**: TypeScript, JavaScript, Python, Java, C++, C#, Go, Rust, PHP, Ruby, Swift, Kotlin, Scala, Markdown
Expand Down
22 changes: 21 additions & 1 deletion docs/getting-started/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,14 @@ Claude Context supports a global configuration file at `~/.context/.env` to simp
### Embedding Provider
| Variable | Description | Default |
|----------|-------------|---------|
| `EMBEDDING_PROVIDER` | Provider: `OpenAI`, `VoyageAI`, `Gemini`, `Ollama` | `OpenAI` |
| `EMBEDDING_PROVIDER` | Provider: `OpenAI`, `AzureOpenAI`, `VoyageAI`, `Gemini`, `Ollama` | `OpenAI` |
| `EMBEDDING_MODEL` | Embedding model name (works for all providers) | Provider-specific default |
| `OPENAI_API_KEY` | OpenAI API key | Required for OpenAI |
| `OPENAI_BASE_URL` | OpenAI API base URL (optional, for custom endpoints) | `https://api.openai.com/v1` |
| `AZURE_OPENAI_API_KEY` | Azure OpenAI API key | Required for Azure OpenAI |
| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI endpoint URL | Required for Azure OpenAI |
| `AZURE_OPENAI_DEPLOYMENT_NAME` | Azure deployment name | Required for Azure OpenAI |
| `AZURE_OPENAI_API_VERSION` | Azure API version | `2024-02-01` |
| `VOYAGEAI_API_KEY` | VoyageAI API key | Required for VoyageAI |
| `GEMINI_API_KEY` | Gemini API key | Required for Gemini |
| `GEMINI_BASE_URL` | Gemini API base URL (optional, for custom endpoints) | `https://generativelanguage.googleapis.com/v1beta` |
Expand All @@ -33,6 +37,8 @@ Claude Context supports a global configuration file at `~/.context/.env` to simp
> **Supported Model Names:**
>
> - OpenAI Models: See `getSupportedModels` in [`openai-embedding.ts`](https://github.com/zilliztech/claude-context/blob/master/packages/core/src/embedding/openai-embedding.ts) for the full list of supported models.
>
> - Azure OpenAI: Uses deployment names instead of model names. Supports the same models as OpenAI (text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002).
>
> - VoyageAI Models: See `getSupportedModels` in [`voyageai-embedding.ts`](https://github.com/zilliztech/claude-context/blob/master/packages/core/src/embedding/voyageai-embedding.ts) for the full list of supported models.
>
Expand Down Expand Up @@ -67,6 +73,8 @@ Claude Context supports a global configuration file at `~/.context/.env` to simp
## 🚀 Quick Setup

### 1. Create Global Config

**Option A: OpenAI**
```bash
mkdir -p ~/.context
cat > ~/.context/.env << 'EOF'
Expand All @@ -77,6 +85,18 @@ MILVUS_TOKEN=your-zilliz-cloud-api-key
EOF
```

**Option B: Azure OpenAI**
```bash
mkdir -p ~/.context
cat > ~/.context/.env << 'EOF'
EMBEDDING_PROVIDER=AzureOpenAI
AZURE_OPENAI_API_KEY=your-azure-api-key
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com
AZURE_OPENAI_DEPLOYMENT_NAME=text-embedding-3-small-deployment
MILVUS_TOKEN=your-zilliz-cloud-api-key
EOF
```

See the [Example File](../../.env.example) for more details.

### 2. Simplified MCP Configuration
Expand Down
Loading