@youdotcom-oss/mcp 1.3.3 → 1.3.5-next.11

package/AGENTS.md

@@ -1,702 +0,0 @@
----
-description: Development guidelines for You.com MCP Server using Bun runtime.
-globs: "*.ts, *.tsx, *.js, *.jsx, package.json"
-alwaysApply: false
----
-
-# You.com MCP Server Development Guide
-
-A Model Context Protocol (MCP) server that provides web search, AI agent, and content extraction capabilities through You.com's APIs.
-
----
-
-> **Note for end users**: If you want to use this MCP server (not develop or contribute), see [README.md](./README.md) for setup instructions, getting started guides, and usage examples.
-
-**This guide (AGENTS.md) is for developers, contributors, and AI coding agents** who want to:
-- Set up a local development environment
-- Understand the codebase architecture
-- Contribute code or bug fixes
-- Run tests and quality checks
-- Review pull requests
-
----
-
-## Tech Stack
-
-- **Runtime**: Bun >= 1.2.21 (not Node.js)
-- **Framework**: Model Context Protocol SDK v1.22.0
-- **HTTP Server**: Hono v4.10.6 with @hono/mcp for HTTP transport (SSE protocol support)
-- **Validation**: Zod 3.25.76 for schema validation
-- **Testing**: Bun test (built-in test runner)
-- **Code Quality**: Biome 2.3.7 (linter + formatter)
-- **Type Checking**: TypeScript 5.9.3
-- **Git Hooks**: lint-staged 16.2.7
-
-## Quick Start
-
-### Setup Environment
-
-```bash
-echo "export YDC_API_KEY=your-actual-api-key-here" > .env
-source .env
-```
-
-### Development Commands
-
-```bash
-bun install                    # Install dependencies
-bun run dev                    # Start stdio server
-bun start                      # Start HTTP server on port 4000
-bun test                       # Run tests
-bun test:coverage              # Run tests with coverage report
-bun test:watch                 # Run tests in watch mode
-bun run check                  # Run all checks (biome + types + package format)
-bun run check:write            # Auto-fix all issues
-```
-
-## Code Style
-
-This project uses [Biome](https://biomejs.dev/) for automated code formatting and linting. Most style rules are enforced automatically via git hooks.
-
-### Manual Adherence Required
-
-**Arrow Functions**: Always use arrow functions for declarations (not enforced by Biome)
-```ts
-// ✅ Preferred
-export const fetchData = async (params: Params) => { ... };
-
-// ❌ Avoid
-export async function fetchData(params: Params) { ... }
-```
-
-**No Unused Exports**: All exports must be actively used (Biome detects unused variables/imports, but NOT unused exports)
-```bash
-# Before adding exports, verify usage:
-grep -r "ExportName" src/
-```
-
-### MCP-Specific Patterns
-
-**Schema Design**: Always use Zod for input/output validation
-```ts
-export const MyToolInputSchema = z.object({
-  query: z.string().min(1).describe('Search query'),
-  limit: z.number().optional().describe('Max results'),
-});
-```
-
-**Error Handling**: Always use try/catch with typed error handling
-```ts
-try {
-  const response = await apiCall();
-  return formatResponse(response);
-} catch (err: unknown) {
-  const errorMessage = err instanceof Error ? err.message : String(err);
-  await logger({ level: 'error', data: `API call failed: ${errorMessage}` });
-  return { content: [{ type: 'text', text: `Error: ${errorMessage}` }], isError: true };
-}
-```
-
-**Logging**: Use `getLogger(mcp)` helper, never console.log
-```ts
-import { getLogger } from '../shared/get-logger.ts';
-
-const logger = getLogger(mcp);
-await logger({ level: 'info', data: `Operation successful: ${result}` });
-await logger({ level: 'error', data: `Operation failed: ${errorMessage}` });
-```
-
-**Response Format**: Return both `content` and `structuredContent`
-```ts
-return {
-  content: [{ type: 'text', text: formattedText }],
-  structuredContent: responseData,
-};
-```
-
-## Development Workflow
-
-### Git Hooks
-
-Git hooks are automatically configured after `bun install`:
-
-- **Pre-commit**: Runs Biome check and format-package on staged files
-- **Setup**: `bun run prepare` (runs automatically with install)
-- Git hooks enforce code quality standards and should never be bypassed
-
-### MCP Inspector
-
-Test and debug MCP tools interactively:
-
-```bash
-bun run inspect  # Automatically loads .env variables
-```
-
-- Opens interactive UI to test MCP tools
-- Requires `YDC_API_KEY` in `.env` file
-- See [MCP Inspector docs](https://modelcontextprotocol.io/docs/tools/inspector)
-
-### Code Quality Commands
-
-```bash
-# Check everything (CI command)
-bun run check                    # Runs biome + types + package format
-
-# Individual checks
-bun run check:biome              # Lint and format check
-bun run check:types              # TypeScript type check
-bun run check:package            # package.json format check
-
-# Auto-fix
-bun run check:write              # Fix all auto-fixable issues
-bun run lint:fix                 # Fix lint issues only
-bun run format                   # Format code only
-bun run format:package           # Format package.json only
-```
-
-## Contributing
-
-For detailed contribution guidelines, including:
-- Bug reporting
-- Feature requests
-- Pull request workflow
-- Commit message conventions (Conventional Commits)
-- Code review process
-
-See [CONTRIBUTING.md](./CONTRIBUTING.md)
-
-## MCP Server Patterns
-
-### Tool Registration
-
-Use Zod schemas for tool parameter validation. See examples:
-- Search tool: `src/search/register-search-tool.ts:7-86`
-- Express tool: `src/express/register-express-tool.ts:7-66`
-- Contents tool: `src/contents/register-contents-tool.ts:7-89`
-
-### Error Handling
-
-Always use try/catch with typed error handling (`err: unknown`). See tool registration files for standard pattern.
-
-### Logging
-
-Use `getLogger(mcp)` helper, never console.log. See `src/shared/get-logger.ts:8-11` for implementation.
-
-### Error Reporting
-
-Include mailto links in error logs using `generateErrorReportLink()` helper (`src/shared/generate-error-report-link.ts:6-37`). This creates one-click error reporting with full diagnostic context.
-
-
-## Testing
-
-### Test Organization
-
-- **Unit Tests**: `src/*/tests/*.spec.ts` - Test individual utilities
-- **Integration Tests**: `src/tests/*.spec.ts` - Test MCP tools end-to-end
-- **Coverage Target**: >80% for core utilities
-
-For test patterns, see:
-- Unit tests: `src/search/tests/search.utils.spec.ts`
-- Integration tests: `src/tests/tool.spec.ts`
-
-### Test Assertion Anti-Patterns
-
-**IMPORTANT: Avoid patterns that silently skip assertions** - they hide failures.
-
-❌ **Early Returns** - Silently exits test, skips remaining assertions
-```ts
-if (!item) return; // Bad: test passes even if item is undefined
-```
-
-❌ **Redundant Conditionals** - Asserts defined, then conditionally checks type
-```ts
-expect(item?.markdown).toBeDefined();
-if (item?.markdown) {
-  expect(typeof item.markdown).toBe('string'); // Redundant!
-}
-```
-
-✅ **Let tests fail naturally** - Use optional chaining and direct assertions:
-```ts
-expect(item).toBeDefined();
-expect(item).toHaveProperty('url'); // Fails with clear error if undefined
-```
-
-### Running Tests
-
-```bash
-bun test                       # All tests
-bun test:coverage              # With coverage report
-bun test:watch                 # Run tests in watch mode
-bun test:coverage:watch        # Coverage with watch mode
-bun test src/search/tests/     # Specific directory
-```
-
-Requires `YDC_API_KEY` environment variable for API tests.
-
-## Troubleshooting
-
-### Common Issues
-
-#### YDC_API_KEY not found
-
-**Symptom**: Error message "YDC_API_KEY environment variable is required"
-
-**Solution**:
-```bash
-# Set up .env file
-echo "export YDC_API_KEY=your-actual-api-key-here" > .env
-source .env
-
-# Or export directly
-export YDC_API_KEY="your-actual-api-key-here"
-
-# Verify it's set
-echo $YDC_API_KEY
-```
-
-#### Build Failures
-
-**Symptom**: `bun run build` fails with TypeScript errors
-
-**Solution**:
-```bash
-# Check TypeScript errors
-bun run check:types
-
-# Fix code quality issues
-bun run check:write
-
-# Clean and rebuild
-rm -rf bin/
-bun run build
-```
-
-#### Test Failures with API Rate Limits
-
-**Symptom**: Tests fail with 429 (Too Many Requests) errors
-
-**Solution**:
-- Wait a few minutes before re-running tests
-- Run specific test suites instead of all tests at once
-- Use `bun test --bail` to stop after first failure
-- Check your API key rate limits at [api.you.com](https://api.you.com)
-
-#### Docker Permission Issues
-
-**Symptom**: Docker build fails with permission errors
-
-**Solution**:
-```bash
-# Ensure Docker daemon is running
-docker info
-
-# Build with sudo if needed (Linux)
-sudo docker build -t youdotcom-mcp-server .
-
-# Check Docker group membership (Linux)
-groups $USER
-```
-
-#### Biome/TypeScript Errors
-
-**Symptom**: Pre-commit hook fails or `bun run check` shows errors
-
-**Solution**:
-```bash
-# Auto-fix most issues
-bun run check:write
-
-# Check specific issues
-bun run check:biome    # Linting and formatting
-bun run check:types    # TypeScript type errors
-bun run check:package  # package.json formatting
-
-# Format code manually
-bun run format
-
-# Fix lint issues manually
-bun run lint:fix
-```
-
-#### Import Resolution Errors
-
-**Symptom**: "Cannot find module" errors in TypeScript
-
-**Solution**:
-- Always use `.js` extensions in imports (even for `.ts` files)
-- Check that the file exists at the specified path
-- Use relative paths correctly (`./` for same directory, `../` for parent)
-- Example: `import { foo } from './utils.js'` (not `./utils`)
-
-#### MCP Client Connection Issues
-
-**Symptom**: MCP client can't connect to server
-
-**Solution for Stdio mode**:
-- Verify the path to `stdio.ts` or `stdio.js` is correct and absolute
-- Check that Bun is installed and in PATH
-- Test manually: `bun src/stdio.ts`
-
-**Solution for HTTP mode**:
-- Verify server is running: `curl http://localhost:4000/mcp-health`
-- Check port isn't in use: `lsof -i :4000` (macOS/Linux)
-- Verify Bearer token matches your API key
-- Check firewall settings
-
-## API Integration
-
-### You.com API Key
-
-This server uses a single `YDC_API_KEY` for all APIs, but they use different authentication methods:
-
-- **Search API** (`you-search`): Uses `X-API-Key` header
-- **Contents API** (`you-contents`): Uses `X-API-Key` header
-- **Agent API** (`you-express`): Uses `Authorization: Bearer` header
-
-**Important**: If you receive 401 Unauthorized errors when using the `you-express` tool, ensure your API key has permissions for agent endpoints.
-
-### API Response Validation
-
-Always validate API responses and handle errors:
-
-```ts
-// Check for error field even with 200 status
-checkResponseForErrors(jsonResponse);
-
-// Validate with Zod
-const validatedResponse = ResponseSchema.parse(jsonResponse);
-
-// Handle specific status codes
-if (response.status === 401) {
-  throw new Error('Invalid or expired API key');
-}
-if (response.status === 403) {
-  throw new Error('API key lacks permissions for this endpoint');
-}
-if (response.status === 429) {
-  throw new Error('Rate limit exceeded');
-}
-```
-
-## Available MCP Tools
-
-### 1. `you-search`
-
-Web and news search using You.com Search API
-
-- Returns web results with snippets and news articles
-- Supports filters: freshness, country, safesearch, file types
-- Authentication: `X-API-Key` header
-
-### 2. `you-express`
-
-Fast AI responses with optional web search
-
-- Best for straightforward queries
-- Fast responses with real-time web information
-- Returns AI-synthesized answer + optional web search results
-- Uses non-streaming JSON responses (`stream: false`)
-- Authentication: `Authorization: Bearer` header
-
-### 3. `you-contents`
-
-Content extraction from web pages
-
-- Extracts full page content in markdown or HTML format
-- Processes multiple URLs in a single API request
-- Returns both text and structured content formats
-- Markdown recommended for text extraction
-- HTML recommended for layout preservation
-- Authentication: `X-API-Key` header
-
-## Architecture
-
-### System Overview
-
-```mermaid
-graph TD
-    Clients["MCP Clients
-    (Claude Desktop, Claude Code, Custom Clients)"]
-    
-    Clients -->|"Stdio (Local)"| Stdio["src/stdio.ts
-    - Process I/O
-    - JSON-RPC"]
-    Clients -->|"HTTP/SSE (Remote)"| HTTP["src/http.ts (Hono + SSE)
-    - /mcp
-    - /mcp-health
-    - Bearer Auth"]
-    
-    Stdio --> Server["src/get-mcp-server.ts
-    MCP Server Factory
-    - registerTool()
-    - Tool Handlers
-    - Logging"]
-    HTTP --> Server
-    
-    Server --> Search["you-search
-    - Validation
-    - Query Build
-    - Formatting"]
-    Server --> Express["you-express
-    - Validation
-    - Transform
-    - Formatting"]
-    Server --> Contents["you-contents
-    - Validation
-    - Multi-URL
-    - Formatting"]
-    
-    Search -->|X-API-Key| APIs["You.com APIs
-    - Search API (ydc-index.io)
-    - Agent API (api.you.com)
-    - Contents API (ydc-index.io)"]
-    Express -->|Bearer| APIs
-    Contents -->|X-API-Key| APIs
-```
-
-### Request Flow
-
-**Stdio Transport (Local Development)**:
-1. MCP Client sends JSON-RPC request via stdin
-2. `stdio.ts` receives and parses request
-3. Calls MCP Server with tool name + parameters
-4. MCP Server validates input with Zod schemas
-5. Tool handler calls You.com API
-6. Response formatted for MCP
-7. JSON-RPC response sent via stdout
-
-**HTTP Transport (Remote Deployment)**:
-1. MCP Client connects via SSE to `/mcp`
-2. Client sends tool request over SSE connection
-3. `http.ts` authenticates Bearer token
-4. Calls MCP Server with tool name + parameters
-5. MCP Server validates input with Zod schemas
-6. Tool handler calls You.com API
-7. Response formatted for MCP
-8. SSE event sent back to client
-
-### Core Server Files
-
-- `src/stdio.ts` - Stdio transport entry point (used by `bun run dev`)
-- `src/http.ts` - HTTP transport with Bearer token auth (Hono app)
-  - `/mcp` - Main MCP endpoint (SSE streaming)
-  - `/mcp-health` - Health check endpoint
-  - Bearer token authentication via `Authorization` header
-  - `Content-Encoding: identity` header handling for compatibility
-- `src/get-mcp-server.ts` - MCP server factory function
-
-### Search Tool (`you-search`)
-
-- `src/search/register-search-tool.ts` - Tool registration with validation
-- `src/search/search.schemas.ts` - Zod schemas for validation
-- `src/search/search.utils.ts` - API calls, query building, formatting
-- `src/search/tests/search.utils.spec.ts` - Unit tests
-
-### Express Agent Tool (`you-express`)
-
-- `src/express/register-express-tool.ts` - Tool registration and request handling
-- `src/express/express.schemas.ts` - Dual schema architecture
-  - API response validation (ExpressAgentApiResponseSchema)
-  - Token-efficient MCP output (ExpressAgentMcpResponseSchema)
-  - API validates full You.com response
-  - MCP output returns only essential fields
-- `src/express/express.utils.ts` - API calls and response transformation
-  - `callExpressAgent()` - Calls You.com Express API (`stream: false`)
-  - Transforms API response to MCP format
-  - `formatExpressAgentResponse()` - Formats MCP response
-  - `agentThrowOnFailedStatus()` - Handles API errors
-- `src/express/tests/express.utils.spec.ts` - Unit tests
-
-### Contents Tool (`you-contents`)
-
-- `src/contents/register-contents-tool.ts` - Tool registration
-  - Calls `fetchContents()` with all URLs in single request
-  - Formats response for text and structured output
-  - Comprehensive error handling (401, 403, 429, 5xx)
-- `src/contents/contents.schemas.ts` - Zod schemas
-  - `ContentsQuerySchema` - Input validation
-  - `ContentsApiResponseSchema` - API response validation
-  - `ContentsStructuredContentSchema` - MCP output format
-- `src/contents/contents.utils.ts` - API calls and formatting
-  - `fetchContents()` - Single API call with all URLs
-  - Uses `X-API-Key` header
-  - Validates response schema
-  - `formatContentsResponse()` - Formats for MCP output
-- `src/contents/tests/contents.utils.spec.ts` - Unit tests
-
-### Shared Utilities
-
-- `src/shared/use-client-version.ts` - User-Agent generation with MCP client version info
-  - `useGetClientVersion(mcp)` - Returns a `getUserAgent` function for creating User-Agent strings
-- `src/shared/get-logger.ts` - MCP server logging
-  - `getLogger(mcp)` - Returns a logging function for MCP server notifications
-- `src/shared/check-response-for-errors.ts` - API response validation
-  - `checkResponseForErrors()` - Validates API responses for error fields
-- `src/shared/generate-error-report-link.ts` - Error reporting utilities
-  - `generateErrorReportLink()` - Creates mailto links for one-click error reporting
-- `src/shared/format-search-results-text.ts` - Search result formatting
-  - `formatSearchResultsText()` - Formats search results for text display
-
-### Library Export
-
-- `src/main.ts` - Public API export file for library consumers
-  - Exports all schemas from contents, express, and search tools
-  - Exports utility functions from contents, express, and search
-  - Exports shared utilities (checkResponseForErrors, formatSearchResultsText)
-  - Used when consuming this package as a library (not as MCP server)
-
-### Integration Tests
-
-- `src/tests/http.spec.ts` - HTTP server endpoint tests
-- `src/tests/tool.spec.ts` - End-to-end MCP tool tests
-
-## Deployment
-
-This section covers local development setup, self-hosting options, and production deployment strategies.
-
-### Local development setup
-
-**Prerequisites:**
-- Bun >= 1.2.21 installed
-- You.com API key from [you.com/platform/api-keys](https://you.com/platform/api-keys)
-
-**Quick start:**
-
-```bash
-# Clone repository
-git clone https://github.com/youdotcom-oss/youdotcom-mcp-server.git
-cd youdotcom-mcp-server
-
-# Install dependencies
-bun install
-
-# Set up environment
-echo "export YDC_API_KEY=your-actual-api-key-here" > .env
-source .env
-
-# Start development server (STDIO mode)
-bun run dev
-
-# Or start HTTP server on port 4000
-bun start
-```
-
-**Verify setup:**
-```bash
-# Test STDIO mode
-echo '{"jsonrpc":"2.0","method":"tools/list","id":1}' | bun src/stdio.ts
-
-# Test HTTP mode (in separate terminal)
-curl http://localhost:4000/mcp-health
-```
-
-### Self-hosting with Docker
-
-**Build and run:**
-
-```bash
-# Build Docker image
-docker build -t youdotcom-mcp-server .
-
-# Run container with API key
-docker run -d \
-  -p 4000:4000 \
-  --name youdotcom-mcp \
-  -e YDC_API_KEY=your-actual-api-key-here \
-  youdotcom-mcp-server
-
-# Check health
-curl http://localhost:4000/mcp-health
-```
-
-**Docker Compose:**
-
-```yaml
-version: '3.8'
-services:
-  youdotcom-mcp:
-    build: .
-    ports:
-      - "4000:4000"
-    environment:
-      - YDC_API_KEY=${YDC_API_KEY}
-    restart: unless-stopped
-```
-
-### Deployment modes
-
-| Mode | Use Case | Transport | Command |
-|------|----------|-----------|---------|
-| **STDIO Dev** | Local development and testing | STDIO | `bun run dev` |
-| **STDIO Prod** | MCP client integration (local) | STDIO | `./bin/stdio.js` |
-| **HTTP Dev** | Local HTTP server testing | HTTP/SSE | `bun start` |
-| **HTTP Prod** | Remote clients, web apps, production | HTTP/SSE | `bun run build && bun bin/http` |
-| **Docker** | Containerized deployment | HTTP/SSE | `docker run ...` |
-
-### Production deployment
-
-**Building for production:**
-
-```bash
-# Build optimized STDIO bundle
-bun run build
-
-# Outputs:
-# - bin/stdio.js (compiled STDIO transport)
-# Note: bin/http is an executable script, not compiled
-```
-
-**Running in production:**
-
-```bash
-# Set API key
-export YDC_API_KEY=your-actual-api-key-here
-
-# STDIO mode (for MCP clients)
-node bin/stdio.js
-
-# HTTP mode (for remote access)
-PORT=4000 bun bin/http
-```
-
-**Environment variables:**
-
-| Variable | Required | Default | Description |
-|----------|----------|---------|-------------|
-| `YDC_API_KEY` | Yes | - | You.com API key |
-| `PORT` | No | 4000 | HTTP server port (HTTP mode only) |
-
-**Production considerations:**
-
-- **Security**: Never expose STDIO mode to external networks
-- **HTTP mode**: Use reverse proxy (nginx, Caddy) with HTTPS in production
-- **Rate limiting**: Consider implementing rate limiting for HTTP endpoints
-- **Monitoring**: Set up health check monitoring on `/mcp-health`
-- **Logging**: MCP server logs to stderr; configure log aggregation as needed
-- **API key rotation**: Restart server after rotating API keys
-
-### MCP client configuration
-
-For connecting MCP clients to your self-hosted server, see the "Adding to your MCP client" section in [README.md](./README.md).
-
-For complete API reference documentation including parameters, response formats, and examples, see [API.md](./docs/API.md).
-
-## Bun Runtime
-
-This project uses Bun (>= 1.2.21) instead of Node.js:
-
-```bash
-bun <file>       # Run TypeScript directly
-bun install      # Install dependencies
-bun test         # Built-in test runner
-```
-
-**Import Extensions** (enforced by Biome):
-- Local files: `.ts` extension
-- NPM packages: `.js` extension
-- JSON files: `.json` with import assertion
-
-See `src/contents/register-contents-tool.ts:1-5` for import examples.
-
-**Build**: Build configuration is defined in `package.json` scripts. The `bun run build` command compiles `src/stdio.ts` to `bin/stdio.js` for production use.