├── .gitignore ├── .dxtignore ├── eslint.config.js ├── tsconfig.json ├── smithery.yaml ├── src ├── index.ts ├── tools │ ├── BaseTool.ts │ ├── BraveImageSearchTool.ts │ ├── BraveNewsSearchTool.ts │ ├── BraveWebSearchTool.ts │ ├── BraveVideoSearchTool.ts │ └── BraveLocalSearchTool.ts ├── utils.ts └── server.ts ├── Dockerfile ├── .github └── workflows │ └── publish.yml ├── package.json ├── manifest.json ├── DEBUGGING.md ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | build 3 | dist 4 | .env 5 | notes.txt 6 | .vscode -------------------------------------------------------------------------------- /.dxtignore: -------------------------------------------------------------------------------- 1 | notes.txt 2 | Dockerfile 3 | eslint.config.js 4 | smithery.yaml 5 | tsconfig.json 6 | DEBUGGING.md 7 | ./src 8 | ./.vscode/ -------------------------------------------------------------------------------- /eslint.config.js: -------------------------------------------------------------------------------- 1 | import antfu from '@antfu/eslint-config'; 2 | 3 | export default antfu({ 4 | formatters: true, 5 | typescript: { 6 | overrides: { 7 | 'no-console': 'off', 8 | }, 9 | }, 10 | stylistic: { 11 | semi: true, 12 | indent: 2, 13 | quotes: 'single', 14 | }, 15 | }); 16 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ES2022", 4 | "rootDir": "./src", 5 | "module": "Node16", 6 | "moduleResolution": "Node16", 7 | "strict": true, 8 | "outDir": "./dist", 9 | "esModuleInterop": true, 10 | "forceConsistentCasingInFileNames": true, 11 | "skipLibCheck": true 12 | }, 13 | "include": ["src/**/*"], 14 | "exclude": ["node_modules"] 15 | } 16 | -------------------------------------------------------------------------------- /smithery.yaml: -------------------------------------------------------------------------------- 1 | startCommand: 2 | type: stdio 3 | configSchema: 4 | type: object 5 | require: 6 | - braveapikey 7 | properties: 8 | braveapikey: 9 | type: string 10 | description: The API key for Brave Search. 11 | commandFunction: 12 | |- 13 | (config) => ({ command: 'node', args: ['dist/index.js'], env: { BRAVE_API_KEY: config.braveapikey } }) 14 | exampleConfig: 15 | braveapikey: YOUR_API_KEY_HERE 16 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | import process from 'node:process'; 4 | import { BraveMcpServer } from './server.js'; 5 | 6 | // Check for API key 7 | const BRAVE_API_KEY = process.env.BRAVE_API_KEY; 8 | if (!BRAVE_API_KEY) { 9 | console.error('Error: BRAVE_API_KEY environment variable is required'); 10 | process.exit(1); 11 | } 12 | 13 | const braveMcpServer = new BraveMcpServer(BRAVE_API_KEY); 14 | braveMcpServer.start().catch((error) => { 15 | console.error('Error starting server:', error); 16 | process.exit(1); 17 | }); 18 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:23.11-alpine AS builder 2 | 3 | # Must be entire project because `prepare` script is run during `npm install` and requires all files. 4 | COPY . /app 5 | 6 | WORKDIR /app 7 | 8 | RUN --mount=type=cache,target=/root/.npm npm install 9 | 10 | FROM node:23.11-alpine AS release 11 | 12 | WORKDIR /app 13 | 14 | COPY --from=builder /app/dist /app/dist 15 | COPY --from=builder /app/package.json /app/package.json 16 | COPY --from=builder /app/package-lock.json /app/package-lock.json 17 | 18 | ENV NODE_ENV=production 19 | 20 | RUN npm ci --ignore-scripts --omit-dev 21 | 22 | ENTRYPOINT ["node", "dist/index.js"] -------------------------------------------------------------------------------- /src/tools/BaseTool.ts: -------------------------------------------------------------------------------- 1 | import type { z } from 'zod'; 2 | 3 | export abstract class BaseTool { 4 | public abstract readonly name: string; 5 | public abstract readonly description: string; 6 | public abstract readonly inputSchema: T; 7 | 8 | protected constructor() {} 9 | 10 | public abstract executeCore(input: z.infer): Promise; 11 | 12 | public async execute(input: z.infer) { 13 | try { 14 | return await this.executeCore(input); 15 | } 16 | catch (error) { 17 | console.error(`Error executing ${this.name}:`, error); 18 | return { 19 | content: [{ 20 | type: 'text' as const, 21 | text: `Error in ${this.name}: ${error}`, 22 | }], 23 | isError: true, 24 | }; 25 | } 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish to NPM 2 | on: 3 | release: 4 | types: [created] 5 | jobs: 6 | publish-to-npm: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v4 10 | - uses: actions/setup-node@v4 11 | with: 12 | node-version: 20.19.0 13 | registry-url: 'https://registry.npmjs.org/' 14 | cache: npm 15 | - name: Install dependencies and build 🔧 16 | run: | 17 | npm ci 18 | npm run build || (echo "Build failed" && exit 1) 19 | - name: Publish to NPM 📦 20 | run: npm publish 21 | env: 22 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 23 | permissions: 24 | contents: read 25 | id-token: write 26 | 27 | create-dxt-release: 28 | needs: publish-to-npm 29 | runs-on: ubuntu-latest 30 | steps: 31 | - uses: actions/checkout@v4 32 | - uses: actions/setup-node@v4 33 | with: 34 | node-version: 20.19.0 35 | cache: npm 36 | - name: Install dependencies and build 🔧 37 | run: | 38 | npm ci 39 | npm run build || (echo "Build failed" && exit 1) 40 | - name: Install Anthropic DXT CLI 41 | run: npm install -g @anthropic-ai/dxt 42 | - name: Create DXT file 43 | run: | 44 | npm install --omit=dev 45 | dxt pack 46 | - name: Debug DXT file 47 | run: | 48 | ls -la *.dxt || echo "No .dxt files found" 49 | find . -name "*.dxt" -type f || echo "No .dxt files found in subdirectories" 50 | - name: Upload DXT to GitHub Release 51 | uses: softprops/action-gh-release@v2 52 | with: 53 | files: ./brave-search-mcp.dxt 54 | env: 55 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 56 | permissions: 57 | contents: write 58 | id-token: write 59 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "brave-search-mcp", 3 | "type": "module", 4 | "version": "0.8.0", 5 | "description": "MCP Server that uses Brave Search API to search for images, general web search, video, news and points of interest.", 6 | "author": "mike.chao.one@gmail.com", 7 | "license": "GPL-3.0-or-later", 8 | "homepage": "https://github.com/mikechao/brave-search-mcp", 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/mikechao/brave-search-mcp.git" 12 | }, 13 | "bugs": { 14 | "url": "https://github.com/mikechao/brave-search-mcp/issues" 15 | }, 16 | "keywords": [ 17 | "brave", 18 | "mcp", 19 | "web-search", 20 | "image-search", 21 | "news-search", 22 | "brave-search-api", 23 | "brave-search", 24 | "brave-search-mcp" 25 | ], 26 | "main": "dist/index.js", 27 | "bin": { 28 | "brave-search-mcp": "dist/index.js" 29 | }, 30 | "files": [ 31 | "LICENSE", 32 | "README.md", 33 | "dist" 34 | ], 35 | "scripts": { 36 | "clean": "shx rm -rf dist && shx mkdir dist", 37 | "build": "npm run clean && tsc && shx chmod +x dist/*.js", 38 | "build:watch": "tsc --sourceMap -p tsconfig.json -w", 39 | "lint": "eslint . --ext .ts,.js,.mjs,.cjs --fix", 40 | "lint:check": "eslint . --ext .ts,.js,.mjs,.cjs", 41 | "typecheck": "tsc --noEmit", 42 | "check": "npm run lint:check && npm run typecheck" 43 | }, 44 | "dependencies": { 45 | "@modelcontextprotocol/sdk": "^1.8.0", 46 | "brave-search": "^0.9.0", 47 | "image-to-base64": "^2.2.0", 48 | "zod": "^3.24.3" 49 | }, 50 | "devDependencies": { 51 | "@antfu/eslint-config": "^4.11.0", 52 | "@modelcontextprotocol/inspector": "^0.14.1", 53 | "@types/express": "^5.0.1", 54 | "@types/image-to-base64": "^2.1.2", 55 | "@types/node": "^22.13.14", 56 | "eslint": "^9.23.0", 57 | "eslint-plugin-format": "^1.0.1", 58 | "shx": "^0.4.0", 59 | "typescript": "^5.8.2" 60 | }, 61 | "overrides": { 62 | "form-data": "^4.0.4" 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "dxt_version": "0.1", 3 | "name": "brave-search-mcp", 4 | "version": "0.8.0", 5 | "description": "MCP Server that uses Brave Search API to search for images, general web search, video, news and points of interest.", 6 | "author": { 7 | "name": "Mike Chao", 8 | "email": "mike.chao.one@gmail.com", 9 | "url": "https://github.com/mikechao" 10 | }, 11 | "homepage": "https://github.com/mikechao/brave-search-mcp", 12 | "documentation": "https://github.com/mikechao/brave-search-mcp/blob/main/README.md", 13 | "server": { 14 | "type": "node", 15 | "entry_point": "dist/index.js", 16 | "mcp_config": { 17 | "command": "node", 18 | "args": [ 19 | "${__dirname}/dist/index.js" 20 | ], 21 | "env": { 22 | "BRAVE_API_KEY": "${user_config.brave_api_key}" 23 | } 24 | } 25 | }, 26 | "tools": [ 27 | { 28 | "name": "brave_web_search", 29 | "description": "Execute web searches using Brave's API" 30 | }, 31 | { 32 | "name": "brave_image_search", 33 | "description": "Get images from the web relevant to the query" 34 | }, 35 | { 36 | "name": "brave_news_search", 37 | "description": "Searches the web for news" 38 | }, 39 | { 40 | "name": "brave_local_search", 41 | "description": "Search for local businesses, services and points of interest" 42 | }, 43 | { 44 | "name": "brave_video_search", 45 | "description": "Search the web for videos" 46 | } 47 | ], 48 | "keywords": [ 49 | "brave search", 50 | "web search", 51 | "image search", 52 | "video search" 53 | ], 54 | "license": "GPL-3.0-or-later", 55 | "user_config": { 56 | "brave_api_key": { 57 | "type": "string", 58 | "title": "Brave Search API Key", 59 | "description": "Your Brave Search API key. You can get one from https://search.brave.com/settings/api-keys", 60 | "sensitive": true, 61 | "required": true 62 | } 63 | }, 64 | "repository": { 65 | "type": "git", 66 | "url": "https://github.com/mikechao/brave-search-mcp.git" 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /src/tools/BraveImageSearchTool.ts: -------------------------------------------------------------------------------- 1 | import type { BraveSearch } from 'brave-search'; 2 | import type { BraveMcpServer } from '../server.js'; 3 | import { SafeSearchLevel } from 'brave-search/dist/types.js'; 4 | import imageToBase64 from 'image-to-base64'; 5 | import { z } from 'zod'; 6 | import { BaseTool } from './BaseTool.js'; 7 | 8 | const imageSearchInputSchema = z.object({ 9 | searchTerm: z.string().describe('The term to search the internet for images of'), 10 | count: z.number().min(1).max(3).optional().default(1).describe('The number of images to search for, minimum 1, maximum 3'), 11 | }); 12 | 13 | export class BraveImageSearchTool extends BaseTool { 14 | public readonly name = 'brave_image_search'; 15 | public readonly description = 'A tool for searching the web for images using the Brave Search API.'; 16 | public readonly inputSchema = imageSearchInputSchema; 17 | public readonly imageByTitle = new Map(); 18 | 19 | constructor(private server: BraveMcpServer, private braveSearch: BraveSearch) { 20 | super(); 21 | } 22 | 23 | public async executeCore(input: z.infer) { 24 | const { searchTerm, count } = input; 25 | this.server.log(`Searching for images of "${searchTerm}" with count ${count}`, 'debug'); 26 | 27 | const imageResults = await this.braveSearch.imageSearch(searchTerm, { 28 | count, 29 | safesearch: SafeSearchLevel.Strict, 30 | }); 31 | this.server.log(`Found ${imageResults.results.length} images for "${searchTerm}"`, 'debug'); 32 | const base64Strings = []; 33 | const titles = []; 34 | for (const result of imageResults.results) { 35 | const base64 = await imageToBase64(result.properties.url); 36 | this.server.log(`Image base64 length: ${base64.length}`, 'debug'); 37 | titles.push(result.title); 38 | base64Strings.push(base64); 39 | this.imageByTitle.set(result.title, base64); 40 | } 41 | const results = []; 42 | for (const [index, title] of titles.entries()) { 43 | results.push({ 44 | type: 'text', 45 | text: `${title}`, 46 | }); 47 | results.push({ 48 | type: 'image', 49 | data: base64Strings[index], 50 | mimeType: 'image/png', 51 | }); 52 | } 53 | this.server.resourceChangedNotification(); 54 | return { content: results }; 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | import type { LocalDescriptionsSearchApiResponse, LocalPoiSearchApiResponse, OpeningHours } from 'brave-search/dist/types.js'; 2 | import type { BraveVideoResult } from './tools/BraveVideoSearchTool.js'; 3 | 4 | export function formatPoiResults(poiData: LocalPoiSearchApiResponse, poiDesc: LocalDescriptionsSearchApiResponse) { 5 | return (poiData.results || []).map((poi) => { 6 | const description = poiDesc.results.find(locationDescription => locationDescription.id === poi.id); 7 | return `Name: ${poi.title}\n` 8 | + `${poi.serves_cuisine ? `Cuisine: ${poi.serves_cuisine.join(', ')}\n` : ''}` 9 | + `Address: ${poi.postal_address.displayAddress}\n` 10 | + `Phone: ${poi.contact?.telephone || 'No phone number found'}\n` 11 | + `Email: ${poi.contact?.email || 'No email found'}\n` 12 | + `Price Range: ${poi.price_range || 'No price range found'}\n` 13 | + `Ratings: ${poi.rating?.ratingValue || 'N/A'} (${poi.rating?.reviewCount}) reviews\n` 14 | + `Hours:\n ${(poi.opening_hours) ? formatOpeningHours(poi.opening_hours) : 'No opening hours found'}\n` 15 | + `Description: ${(description) ? description.description : 'No description found'}\n`; 16 | }).join('\n---\n'); 17 | } 18 | 19 | export function formatVideoResults(results: BraveVideoResult[]) { 20 | return (results || []).map((video) => { 21 | return `Title: ${video.title}\n` 22 | + `URL: ${video.url}\n` 23 | + `Description: ${video.description}\n` 24 | + `Age: ${video.age}\n` 25 | + `Duration: ${video.video.duration}\n` 26 | + `Views: ${video.video.views}\n` 27 | + `Creator: ${video.video.creator}\n` 28 | + `${('requires_subscription' in video.video) 29 | ? (video.video.requires_subscription ? 'Requires subscription\n' : 'No subscription\n') 30 | : ''} ` 31 | + `${('tags' in video.video && video.video.tags) 32 | ? (`Tags: ${video.video.tags.join(', ')}`) 33 | : ''} ` 34 | ; 35 | }).join('\n---\n'); 36 | } 37 | 38 | function formatOpeningHours(data: OpeningHours): string { 39 | const today = data.current_day.map((day) => { 40 | return `${day.full_name} ${day.opens} - ${day.closes}\n`; 41 | }); 42 | const weekly = data.days.map((daySlot) => { 43 | return daySlot.map((day) => { 44 | return `${day.full_name} ${day.opens} - ${day.closes}`; 45 | }); 46 | }); 47 | return `Today: ${today}\nWeekly:\n${weekly.join('\n')}`; 48 | } 49 | -------------------------------------------------------------------------------- /src/tools/BraveNewsSearchTool.ts: -------------------------------------------------------------------------------- 1 | import type { BraveSearch } from 'brave-search'; 2 | import type { BraveMcpServer } from '../server.js'; 3 | import { z } from 'zod'; 4 | import { BaseTool } from './BaseTool.js'; 5 | 6 | const newsSearchInputSchema = z.object({ 7 | query: z.string().describe('The term to search the internet for news articles, trending topics, or recent events'), 8 | count: z.number().min(1).max(20).default(10).optional().describe('The number of results to return, minimum 1, maximum 20'), 9 | freshness: z.union([ 10 | z.enum(['pd', 'pw', 'pm', 'py']), 11 | z.string().regex(/^\d{4}-\d{2}-\d{2}to\d{4}-\d{2}-\d{2}$/, 'Date range must be in format YYYY-MM-DDtoYYYY-MM-DD') 12 | ]) 13 | .optional() 14 | .describe( 15 | `Filters search results by when they were discovered. 16 | The following values are supported: 17 | - pd: Discovered within the last 24 hours. 18 | - pw: Discovered within the last 7 Days. 19 | - pm: Discovered within the last 31 Days. 20 | - py: Discovered within the last 365 Days. 21 | - YYYY-MM-DDtoYYYY-MM-DD: Custom date range (e.g., 2022-04-01to2022-07-30)`, 22 | ), 23 | }); 24 | 25 | export class BraveNewsSearchTool extends BaseTool { 26 | public readonly name = 'brave_news_search'; 27 | public readonly description = 'Searches for news articles using the Brave Search API. ' 28 | + 'Use this for recent events, trending topics, or specific news stories. ' 29 | + 'Returns a list of articles with titles, URLs, and descriptions. ' 30 | + 'Maximum 20 results per request.'; 31 | 32 | public readonly inputSchema = newsSearchInputSchema; 33 | 34 | constructor(private braveMcpServer: BraveMcpServer, private braveSearch: BraveSearch) { 35 | super(); 36 | } 37 | 38 | public async executeCore(input: z.infer) { 39 | const { query, count, freshness } = input; 40 | const newsResult = await this.braveSearch.newsSearch(query, { 41 | count, 42 | ...(freshness ? { freshness } : {}), 43 | }); 44 | if (!newsResult.results || newsResult.results.length === 0) { 45 | this.braveMcpServer.log(`No news results found for "${query}"`); 46 | const text = `No news results found for "${query}"`; 47 | return { content: [{ type: 'text' as const, text }] }; 48 | } 49 | 50 | const text = newsResult.results 51 | .map(result => 52 | `Title: ${result.title}\n` 53 | + `URL: ${result.url}\n` 54 | + `Age: ${result.age}\n` 55 | + `Description: ${result.description}\n`, 56 | ) 57 | .join('\n\n'); 58 | return { content: [{ type: 'text' as const, text }] }; 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /src/tools/BraveWebSearchTool.ts: -------------------------------------------------------------------------------- 1 | import type { BraveSearch } from 'brave-search'; 2 | import type { BraveMcpServer } from '../server.js'; 3 | import { SafeSearchLevel } from 'brave-search/dist/types.js'; 4 | import { z } from 'zod'; 5 | import { BaseTool } from './BaseTool.js'; 6 | 7 | const webSearchInputSchema = z.object({ 8 | query: z.string().describe('The term to search the internet for'), 9 | count: z.number().min(1).max(20).default(10).optional().describe('The number of results to return, minimum 1, maximum 20'), 10 | offset: z.number().min(0).default(0).optional().describe('The offset for pagination, minimum 0'), 11 | freshness: z.union([ 12 | z.enum(['pd', 'pw', 'pm', 'py']), 13 | z.string().regex(/^\d{4}-\d{2}-\d{2}to\d{4}-\d{2}-\d{2}$/, 'Date range must be in format YYYY-MM-DDtoYYYY-MM-DD') 14 | ]) 15 | .optional() 16 | .describe( 17 | `Filters search results by when they were discovered. 18 | The following values are supported: 19 | - pd: Discovered within the last 24 hours. 20 | - pw: Discovered within the last 7 Days. 21 | - pm: Discovered within the last 31 Days. 22 | - py: Discovered within the last 365 Days. 23 | - YYYY-MM-DDtoYYYY-MM-DD: Custom date range (e.g., 2022-04-01to2022-07-30)`, 24 | ), 25 | }); 26 | 27 | export class BraveWebSearchTool extends BaseTool { 28 | public readonly name = 'brave_web_search'; 29 | public readonly description = 'Performs a web search using the Brave Search API, ideal for general queries, and online content. ' 30 | + 'Use this for broad information gathering, recent events, or when you need diverse web sources. ' 31 | + 'Maximum 20 results per request '; 32 | 33 | public readonly inputSchema = webSearchInputSchema; 34 | 35 | constructor(private braveMcpServer: BraveMcpServer, private braveSearch: BraveSearch) { 36 | super(); 37 | } 38 | 39 | public async executeCore(input: z.infer) { 40 | const { query, count, offset, freshness } = input; 41 | const results = await this.braveSearch.webSearch(query, { 42 | count, 43 | offset, 44 | safesearch: SafeSearchLevel.Strict, 45 | ...(freshness ? { freshness } : {}), 46 | }); 47 | if (!results.web || results.web?.results.length === 0) { 48 | this.braveMcpServer.log(`No results found for "${query}"`); 49 | const text = `No results found for "${query}"`; 50 | return { content: [{ type: 'text' as const, text }] }; 51 | } 52 | const text = results.web.results.map(result => `Title: ${result.title}\nURL: ${result.url}\nDescription: ${result.description}`).join('\n\n'); 53 | return { content: [{ type: 'text' as const, text }] }; 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /DEBUGGING.md: -------------------------------------------------------------------------------- 1 | ## Debugging 2 | 3 | 1. Clone the repo 4 | 5 | 2. Install Dependencies and build it 6 | 7 | ```bash 8 | npm install 9 | ``` 10 | 11 | 3. Build the app 12 | 13 | ```bash 14 | npm run build 15 | ``` 16 | 17 | ### Use the VS Code Run and Debug Function 18 | 19 | ⚠ Does not seem to work on Windows 10/11, but works in WSL2 20 | 21 | Use the VS Code 22 | [Run and Debug launcher](https://code.visualstudio.com/docs/debugtest/debugging#_start-a-debugging-session) with fully 23 | functional breakpoints in the code: 24 | 25 | 1. Locate and select the run debug. 26 | 2. Select the configuration labeled "`MCP Server Launcher`" in the dropdown. 27 | 3. Select the run/debug button. 28 | We can debug the various tools using [MCP Inspector](https://github.com/modelcontextprotocol/inspector) and VS Code. 29 | 30 | ### VS Code Debug setup 31 | 32 | To set up local debugging with breakpoints: 33 | 34 | 1. Store Brave API Key in the VS Code 35 | 36 | - Open the Command Palette (Cmd/Ctrl + Shift + P). 37 | - Type `Preferences: Open User Settings (JSON)`. 38 | - Add the following snippet: 39 | 40 | ```json 41 | { 42 | "brave.search.api.key": "your-api-key-here" 43 | } 44 | ``` 45 | 46 | 2. Create or update `.vscode/launch.json`: 47 | 48 | ```json 49 | { 50 | "version": "0.2.0", 51 | "configurations": [ 52 | { 53 | "type": "node", 54 | "request": "launch", 55 | "name": "MCP Server Launcher", 56 | "skipFiles": ["/**"], 57 | "program": "${workspaceFolder}/node_modules/@modelcontextprotocol/inspector/cli/build/cli.js", 58 | "outFiles": ["${workspaceFolder}/dist/**/*.js"], 59 | "env": { 60 | "BRAVE_API_KEY": "${config:brave.search.api.key}", 61 | "DEBUG": "true" 62 | }, 63 | "args": ["dist/index.js"], 64 | "sourceMaps": true, 65 | "console": "integratedTerminal", 66 | "internalConsoleOptions": "neverOpen", 67 | "preLaunchTask": "npm: build:watch" 68 | }, 69 | { 70 | "type": "node", 71 | "request": "attach", 72 | "name": "Attach to Debug Hook Process", 73 | "port": 9332, 74 | "skipFiles": ["/**"], 75 | "sourceMaps": true, 76 | "outFiles": ["${workspaceFolder}/dist/**/*.js"] 77 | }, 78 | { 79 | "type": "node", 80 | "request": "attach", 81 | "name": "Attach to REPL Process", 82 | "port": 9333, 83 | "skipFiles": ["/**"], 84 | "sourceMaps": true, 85 | "outFiles": ["${workspaceFolder}/dist/**/*.js"] 86 | } 87 | ], 88 | "compounds": [ 89 | { 90 | "name": "Attach to MCP Server", 91 | "configurations": ["Attach to Debug Hook Process", "Attach to REPL Process"] 92 | } 93 | ] 94 | } 95 | ``` 96 | 97 | 3. Create `.vscode/tasks.json`: 98 | 99 | ```json 100 | { 101 | "version": "2.0.0", 102 | "tasks": [ 103 | { 104 | "type": "npm", 105 | "script": "build:watch", 106 | "group": { 107 | "kind": "build", 108 | "isDefault": true 109 | }, 110 | "problemMatcher": ["$tsc"] 111 | } 112 | ] 113 | } 114 | ``` -------------------------------------------------------------------------------- /src/server.ts: -------------------------------------------------------------------------------- 1 | import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'; 2 | import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'; 3 | import { ListResourcesRequestSchema, ReadResourceRequestSchema } from '@modelcontextprotocol/sdk/types.js'; 4 | import { BraveSearch } from 'brave-search'; 5 | import { BraveImageSearchTool } from './tools/BraveImageSearchTool.js'; 6 | import { BraveLocalSearchTool } from './tools/BraveLocalSearchTool.js'; 7 | import { BraveNewsSearchTool } from './tools/BraveNewsSearchTool.js'; 8 | import { BraveVideoSearchTool } from './tools/BraveVideoSearchTool.js'; 9 | import { BraveWebSearchTool } from './tools/BraveWebSearchTool.js'; 10 | 11 | export class BraveMcpServer { 12 | private server: McpServer; 13 | private braveSearch: BraveSearch; 14 | private imageSearchTool: BraveImageSearchTool; 15 | private webSearchTool: BraveWebSearchTool; 16 | private localSearchTool: BraveLocalSearchTool; 17 | private newsSearchTool: BraveNewsSearchTool; 18 | private videoSearchTool: BraveVideoSearchTool; 19 | 20 | constructor(private braveSearchApiKey: string) { 21 | this.server = new McpServer( 22 | { 23 | name: 'Brave Search MCP Server', 24 | description: 'A server that provides tools for searching the web, images, videos, and local businesses using the Brave Search API.', 25 | version: '0.6.0', 26 | }, 27 | { 28 | capabilities: { 29 | resources: {}, 30 | tools: {}, 31 | logging: {}, 32 | }, 33 | }, 34 | ); 35 | this.braveSearch = new BraveSearch(braveSearchApiKey); 36 | this.imageSearchTool = new BraveImageSearchTool(this, this.braveSearch); 37 | this.webSearchTool = new BraveWebSearchTool(this, this.braveSearch); 38 | this.localSearchTool = new BraveLocalSearchTool(this, this.braveSearch, this.webSearchTool, braveSearchApiKey); 39 | this.newsSearchTool = new BraveNewsSearchTool(this, this.braveSearch); 40 | this.videoSearchTool = new BraveVideoSearchTool(this, this.braveSearch, braveSearchApiKey); 41 | this.setupTools(); 42 | this.setupResourceListener(); 43 | } 44 | 45 | private setupTools(): void { 46 | this.server.tool( 47 | this.imageSearchTool.name, 48 | this.imageSearchTool.description, 49 | this.imageSearchTool.inputSchema.shape, 50 | this.imageSearchTool.execute.bind(this.imageSearchTool), 51 | ); 52 | this.server.tool( 53 | this.webSearchTool.name, 54 | this.webSearchTool.description, 55 | this.webSearchTool.inputSchema.shape, 56 | this.webSearchTool.execute.bind(this.webSearchTool), 57 | ); 58 | this.server.tool( 59 | this.localSearchTool.name, 60 | this.localSearchTool.description, 61 | this.localSearchTool.inputSchema.shape, 62 | this.localSearchTool.execute.bind(this.localSearchTool), 63 | ); 64 | this.server.tool( 65 | this.newsSearchTool.name, 66 | this.newsSearchTool.description, 67 | this.newsSearchTool.inputSchema.shape, 68 | this.newsSearchTool.execute.bind(this.newsSearchTool), 69 | ); 70 | this.server.tool( 71 | this.videoSearchTool.name, 72 | this.videoSearchTool.description, 73 | this.videoSearchTool.inputSchema.shape, 74 | this.videoSearchTool.execute.bind(this.videoSearchTool), 75 | ); 76 | } 77 | 78 | private setupResourceListener(): void { 79 | this.server.server.setRequestHandler(ListResourcesRequestSchema, async () => ({ 80 | resources: [ 81 | ...Array.from(this.imageSearchTool.imageByTitle.keys()).map(title => ({ 82 | uri: `brave-image://${title}`, 83 | mimeType: 'image/png', 84 | name: `${title}`, 85 | })), 86 | ], 87 | })); 88 | 89 | this.server.server.setRequestHandler(ReadResourceRequestSchema, async (request) => { 90 | const uri = request.params.uri.toString(); 91 | if (uri.startsWith('brave-image://')) { 92 | const title = uri.split('://')[1]; 93 | const image = this.imageSearchTool.imageByTitle.get(title); 94 | if (image) { 95 | return { 96 | contents: [{ 97 | uri, 98 | mimeType: 'image/png', 99 | blob: image, 100 | }], 101 | }; 102 | } 103 | } 104 | return { 105 | content: [{ type: 'text', text: `Resource not found: ${uri}` }], 106 | isError: true, 107 | }; 108 | }); 109 | } 110 | 111 | public async start() { 112 | const transport = new StdioServerTransport(); 113 | await this.server.connect(transport); 114 | this.log('Server is running with Stdio transport'); 115 | } 116 | 117 | public resourceChangedNotification() { 118 | this.server.server.notification({ 119 | method: 'notifications/resources/list_changed', 120 | }); 121 | } 122 | 123 | public log( 124 | message: string, 125 | level: 'error' | 'debug' | 'info' | 'notice' | 'warning' | 'critical' | 'alert' | 'emergency' = 'info', 126 | ): void { 127 | this.server.server.sendLoggingMessage({ 128 | level, 129 | message, 130 | }); 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /src/tools/BraveVideoSearchTool.ts: -------------------------------------------------------------------------------- 1 | import type { BraveSearch } from 'brave-search'; 2 | import type { BraveSearchOptions, Profile, Query, VideoData, VideoResult } from 'brave-search/dist/types.js'; 3 | import type { BraveMcpServer } from '../server.js'; 4 | import axios from 'axios'; 5 | import { SafeSearchLevel } from 'brave-search/dist/types.js'; 6 | import { z } from 'zod'; 7 | import { formatVideoResults } from '../utils.js'; 8 | import { BaseTool } from './BaseTool.js'; 9 | 10 | // workaround for https://github.com/erik-balfe/brave-search/pull/4 11 | // not being merged yet into brave-search 12 | export interface BraveVideoData extends VideoData { 13 | /** 14 | * Whether the video requires a subscription. 15 | * @type {boolean} 16 | */ 17 | requires_subscription?: boolean; 18 | /** 19 | * A list of tags relevant to the video. 20 | * @type {string[]} 21 | */ 22 | tags?: string[]; 23 | /** 24 | * A profile associated with the video. 25 | * @type {Profile} 26 | */ 27 | author?: Profile; 28 | } 29 | 30 | export interface BraveVideoResult extends Omit { 31 | video: BraveVideoData; 32 | } 33 | 34 | export interface VideoSearchApiResponse { 35 | /** 36 | * The type of search API result. The value is always video. 37 | * @type {string} 38 | */ 39 | type: 'video'; 40 | /** 41 | * Video search query string. 42 | * @type {Query} 43 | */ 44 | query: Query; 45 | /** 46 | * The list of video results for the given query. 47 | * @type {BraveVideoResult[]} 48 | */ 49 | results: BraveVideoResult[]; 50 | } 51 | 52 | export interface VideoSearchOptions extends Pick { 53 | } 54 | // end workaround 55 | 56 | const videoSearchInputSchema = z.object({ 57 | query: z.string().describe('The term to search the internet for videos of'), 58 | count: z.number().min(1).max(20).default(10).optional().describe('The number of results to return, minimum 1, maximum 20'), 59 | freshness: z.union([ 60 | z.enum(['pd', 'pw', 'pm', 'py']), 61 | z.string().regex(/^\d{4}-\d{2}-\d{2}to\d{4}-\d{2}-\d{2}$/, 'Date range must be in format YYYY-MM-DDtoYYYY-MM-DD') 62 | ]) 63 | .optional() 64 | .describe( 65 | `Filters search results by when they were discovered. 66 | The following values are supported: 67 | - pd: Discovered within the last 24 hours. 68 | - pw: Discovered within the last 7 Days. 69 | - pm: Discovered within the last 31 Days. 70 | - py: Discovered within the last 365 Days. 71 | - YYYY-MM-DDtoYYYY-MM-DD: Custom date range (e.g., 2022-04-01to2022-07-30)`, 72 | ), 73 | }); 74 | 75 | export class BraveVideoSearchTool extends BaseTool { 76 | public readonly name = 'brave_video_search'; 77 | public readonly description = 'Searches for videos using the Brave Search API. ' 78 | + 'Use this for video content, tutorials, or any media-related queries. ' 79 | + 'Returns a list of videos with titles, URLs, and descriptions. ' 80 | + 'Maximum 20 results per request.'; 81 | 82 | public readonly inputSchema = videoSearchInputSchema; 83 | 84 | private baseUrl = 'https://api.search.brave.com/res/v1'; 85 | 86 | constructor(private braveMcpServer: BraveMcpServer, private braveSearch: BraveSearch, private apiKey: string) { 87 | super(); 88 | } 89 | 90 | public async executeCore(input: z.infer) { 91 | const { query, count, freshness } = input; 92 | const videoSearchResults = await this.videoSearch(query, { 93 | count, 94 | safesearch: SafeSearchLevel.Strict, 95 | ...(freshness ? { freshness } : {}), 96 | }); 97 | if (!videoSearchResults.results || videoSearchResults.results.length === 0) { 98 | this.braveMcpServer.log(`No video results found for "${query}"`); 99 | const text = `No video results found for "${query}"`; 100 | return { content: [{ type: 'text' as const, text }] }; 101 | } 102 | 103 | const text = formatVideoResults(videoSearchResults.results); 104 | return { content: [{ type: 'text' as const, text }] }; 105 | } 106 | 107 | // workaround for https://github.com/erik-balfe/brave-search/pull/4 108 | // not being merged yet into brave-search 109 | private async videoSearch( 110 | query: string, 111 | options: VideoSearchOptions = {}, 112 | ): Promise { 113 | const response = await axios.get( 114 | `${this.baseUrl}/videos/search?`, 115 | { 116 | params: { 117 | q: query, 118 | ...this.formatOptions(options), 119 | }, 120 | headers: this.getHeaders(), 121 | }, 122 | ); 123 | return response.data; 124 | } 125 | 126 | private formatOptions(options: Record): Record { 127 | return Object.entries(options).reduce( 128 | (acc, [key, value]) => { 129 | if (value !== undefined) { 130 | acc[key] = value.toString(); 131 | } 132 | return acc; 133 | }, 134 | {} as Record, 135 | ); 136 | } 137 | 138 | private getHeaders() { 139 | return { 140 | 'Accept': 'application/json', 141 | 'Accept-Encoding': 'gzip', 142 | 'X-Subscription-Token': this.apiKey, 143 | }; 144 | } 145 | // end workaround 146 | } 147 | -------------------------------------------------------------------------------- /src/tools/BraveLocalSearchTool.ts: -------------------------------------------------------------------------------- 1 | import type { BraveSearch, LocalDescriptionsSearchApiResponse, LocalPoiSearchApiResponse } from 'brave-search'; 2 | import type { BraveMcpServer } from '../server.js'; 3 | import type { BraveWebSearchTool } from './BraveWebSearchTool.js'; 4 | import { SafeSearchLevel } from 'brave-search/dist/types.js'; 5 | import { z } from 'zod'; 6 | import { formatPoiResults } from '../utils.js'; 7 | import { BaseTool } from './BaseTool.js'; 8 | 9 | const localSearchInputSchema = z.object({ 10 | query: z.string().describe('Local search query (e.g. \'pizza near Central Park\')'), 11 | count: z.number().min(1).max(20).default(10).optional().describe('The number of results to return, minimum 1, maximum 20'), 12 | }); 13 | 14 | export class BraveLocalSearchTool extends BaseTool { 15 | public readonly name = 'brave_local_search'; 16 | public readonly description = 'Searches for local businesses and places using Brave\'s Local Search API. ' 17 | + 'Best for queries related to physical locations, businesses, restaurants, services, etc. ' 18 | + 'Returns detailed information including:\n' 19 | + '- Business names and addresses\n' 20 | + '- Ratings and review counts\n' 21 | + '- Phone numbers and opening hours\n' 22 | + 'Use this when the query implies \'near me\' or mentions specific locations. ' 23 | + 'Automatically falls back to web search if no local results are found.'; 24 | 25 | public readonly inputSchema = localSearchInputSchema; 26 | 27 | private baseUrl = 'https://api.search.brave.com/res/v1'; 28 | 29 | constructor(private braveMcpServer: BraveMcpServer, private braveSearch: BraveSearch, private webSearchTool: BraveWebSearchTool, private apiKey: string) { 30 | super(); 31 | } 32 | 33 | public async executeCore(input: z.infer) { 34 | const { query, count } = input; 35 | const results = await this.braveSearch.webSearch(query, { 36 | count, 37 | safesearch: SafeSearchLevel.Strict, 38 | result_filter: 'locations', 39 | }); 40 | // it looks like the count parameter is only good for web search results 41 | if (!results.locations || results.locations?.results.length === 0) { 42 | this.braveMcpServer.log(`No location results found for "${query}" falling back to web search. Make sure your API Plan is at least "Pro"`); 43 | return this.webSearchTool.executeCore({ query, count, offset: 0 }); 44 | } 45 | const allIds = results.locations.results.map(result => result.id); 46 | // count is restricted to 20 in the schema, and the location api supports up to 20 at a time 47 | // so we can just use the count parameter to limit the number of ids, take the first "count" ids 48 | const ids = allIds.slice(0, count); 49 | this.braveMcpServer.log(`Using ${ids.length} of ${allIds.length} location IDs for "${query}"`, 'debug'); 50 | const formattedText = []; 51 | 52 | const localPoiSearchApiResponse = await this.localPoiSearch(ids); 53 | // the call to localPoiSearch does not return the id of the pois 54 | // add them here, they should be in the same order as the ids 55 | // and the same order of id in localDescriptionsSearchApiResponse 56 | localPoiSearchApiResponse.results.forEach((result, index) => { 57 | (result as any).id = ids[index]; 58 | }); 59 | const localDescriptionsSearchApiResponse = await this.localDescriptionsSearch(ids); 60 | const text = formatPoiResults(localPoiSearchApiResponse, localDescriptionsSearchApiResponse); 61 | formattedText.push(text); 62 | const finalText = formattedText.join('\n\n'); 63 | return { content: [{ type: 'text' as const, text: finalText }] }; 64 | } 65 | 66 | // workaround for https://github.com/erik-balfe/brave-search/pull/3 67 | // not being merged yet into brave-search 68 | private async localPoiSearch(ids: string[]) { 69 | try { 70 | const qs = ids.map(id => `ids=${encodeURIComponent(id)}`).join('&'); 71 | const url = `${this.baseUrl}/local/pois?${qs}`; 72 | this.braveMcpServer.log(`Fetching local POI data from ${url}`, 'debug'); 73 | const res = await fetch(url, { 74 | method: 'GET', 75 | headers: this.getHeaders(), 76 | redirect: 'follow', 77 | }); 78 | if (!res.ok) { 79 | throw new Error(`Error fetching local POI data Status:${res.status} Status Text:${res.statusText} Headers:${JSON.stringify(res.headers)}`); 80 | } 81 | const data = (await res.json()) as LocalPoiSearchApiResponse; 82 | return data; 83 | } 84 | catch (error) { 85 | this.handleError(error); 86 | throw error; 87 | } 88 | } 89 | 90 | private async localDescriptionsSearch(ids: string[]) { 91 | try { 92 | const qs = ids.map(id => `ids=${encodeURIComponent(id)}`).join('&'); 93 | const url = `${this.baseUrl}/local/descriptions?${qs}`; 94 | const res = await fetch(url, { 95 | method: 'GET', 96 | headers: this.getHeaders(), 97 | redirect: 'follow', 98 | }); 99 | if (!res.ok) { 100 | const responseText = await res.text(); 101 | this.braveMcpServer.log(`Error response body: ${responseText}`, 'error'); 102 | this.braveMcpServer.log(`Response headers: ${JSON.stringify(Object.fromEntries(res.headers.entries()))}`, 'error'); 103 | this.braveMcpServer.log(`Request URL: ${url}`, 'error'); 104 | this.braveMcpServer.log(`Request headers: ${JSON.stringify(this.getHeaders())}`, 'error'); 105 | if (res.status === 429) { 106 | this.braveMcpServer.log('429 Rate limit exceeded, consider adding delay between requests', 'error'); 107 | } 108 | else if (res.status === 403) { 109 | this.braveMcpServer.log('403 Authentication error - check your API key', 'error'); 110 | } 111 | else if (res.status === 500) { 112 | this.braveMcpServer.log('500 Internal server error - might be an issue with request format or API temporary issues', 'error'); 113 | } 114 | // return an empty response instead of error so we can at least return the pois results 115 | return { 116 | type: 'local_descriptions', 117 | results: [], 118 | } as LocalDescriptionsSearchApiResponse; 119 | } 120 | const data = (await res.json()) as LocalDescriptionsSearchApiResponse; 121 | return data; 122 | } 123 | catch (error) { 124 | this.handleError(error); 125 | throw error; 126 | } 127 | } 128 | 129 | private handleError(error: any) { 130 | this.braveMcpServer.log(`${error}`, 'error'); 131 | } 132 | 133 | private getHeaders() { 134 | return { 135 | 'Accept': '*/*', 136 | 'Accept-Encoding': 'gzip, deflate, br', 137 | 'Connection': 'keep-alive', 138 | 'X-Subscription-Token': this.apiKey, 139 | 'User-Agent': 'BraveSearchMCP/1.0', 140 | 'Content-Type': 'application/json', 141 | 'Cache-Control': 'no-cache', 142 | }; 143 | } 144 | // end workaround 145 | } 146 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Brave Search MCP Server 2 | 3 | An MCP Server implementation that integrates the [Brave Search API](https://brave.com/search/api/), providing, Web Search, Local Points of Interest Search, Video Search, Image Search and News Search capabilities 4 | 5 | 6 | Brave Search MCP server 7 | 8 | 9 | ## Features 10 | 11 | - **Web Search**: Perform a regular search on the web 12 | - **Image Search**: Search the web for images. Image search results will be available as a Resource 13 | - **News Search**: Search the web for news 14 | - **Video Search**: Search the web for videos 15 | - **Local Points of Interest Search**: Search for local physical locations, businesses, restaurants, services, etc 16 | 17 | ## Tools 18 | 19 | - **brave_web_search** 20 | 21 | - Execute web searches using Brave's API 22 | - Inputs: 23 | - `query` (string): The term to search the internet for 24 | - `count` (number, optional): The number of results to return (max 20, default 10) 25 | - `offset` (number, optional, default 0): The offset for pagination 26 | - `freshness` (enum, optional): Filters search results by when they were discovered 27 | - The following values are supported 28 | - pd: Discovered within the last 24 hours. 29 | - pw: Discovered within the last 7 Days. 30 | - pm: Discovered within the last 31 Days. 31 | - py: Discovered within the last 365 Days 32 | - YYYY-MM-DDtoYYYY-MM-DD: Custom date range (e.g., 2022-04-01to2022-07-30) 33 | 34 | - **brave_image_search** 35 | 36 | - Get images from the web relevant to the query 37 | - Inputs: 38 | - `query` (string): The term to search the internet for images of 39 | - `count` (number, optional): The number of images to return (max 3, default 1) 40 | 41 | - **brave_news_search** 42 | 43 | - Searches the web for news 44 | - Inputs: 45 | - `query` (string): The term to search the internet for news articles, trending topics, or recent events 46 | - `count` (number, optional): The number of results to return (max 20, default 10) 47 | - `freshness` (enum, optional): Filters search results by when they were discovered 48 | - The following values are supported 49 | - pd: Discovered within the last 24 hours. 50 | - pw: Discovered within the last 7 Days. 51 | - pm: Discovered within the last 31 Days. 52 | - py: Discovered within the last 365 Days 53 | - YYYY-MM-DDtoYYYY-MM-DD: Custom date range (e.g., 2022-04-01to2022-07-30) 54 | 55 | - **brave_local_search** 56 | 57 | - Search for local businesses, services and points of interest 58 | - **REQUIRES** subscription to the Pro api plan for location results 59 | - Falls back to brave_web_search if no location results are found 60 | - Inputs: 61 | - `query` (string): Local search term 62 | - `count` (number, optional): The number of results to return (max 20, default 5) 63 | 64 | - **brave_video_search** 65 | 66 | - Search the web for videos 67 | - Inputs: 68 | - `query`: (string): The term to search for videos 69 | - `count`: (number, optional): The number of videos to return (max 20, default 10) 70 | - `freshness` (enum, optional): Filters search results by when they were discovered 71 | - The following values are supported 72 | - pd: Discovered within the last 24 hours. 73 | - pw: Discovered within the last 7 Days. 74 | - pm: Discovered within the last 31 Days. 75 | - py: Discovered within the last 365 Days 76 | - YYYY-MM-DDtoYYYY-MM-DD: Custom date range (e.g., 2022-04-01to2022-07-30) 77 | 78 | ## Configuration 79 | 80 | ### Getting an API Key 81 | 82 | 1. Sign up for a [Brave Search API account](https://brave.com/search/api/) 83 | 2. Choose a plan (Free tier available with 2,000 queries/month) 84 | 3. Generate your API key [from the developer dashboard](https://api.search.brave.com/app/keys) 85 | 86 | ### Usage with Claude Code 87 | 88 | For [Claude Code](https://claude.ai/code) users, run this command: 89 | 90 | **Windows:** 91 | 92 | ```bash 93 | claude mcp add-json brave-search '{"command":"cmd","args":["/c","npx","-y","brave-search-mcp"],"env":{"BRAVE_API_KEY":"YOUR_API_KEY_HERE"}}' 94 | ``` 95 | 96 | **Linux/macOS:** 97 | 98 | ```bash 99 | claude mcp add-json brave-search '{"command":"npx","args":["-y","brave-search-mcp"],"env":{"BRAVE_API_KEY":"YOUR_API_KEY_HERE"}}' 100 | ``` 101 | 102 | Replace `YOUR_API_KEY_HERE` with your actual Brave Search API key. 103 | 104 | ### Usage with Claude Desktop 105 | 106 | ## Desktop Extension (DXT) 107 | 108 | 1. Download the `dxt` file from the [Releases](https://github.com/mikechao/brave-search-mcp/releases) 109 | 2. Open it with Claude Desktop 110 | or 111 | Go to File -> Settings -> Extensions and drag the .DXT file to the window to install it 112 | 113 | ## Docker 114 | 115 | 1. Clone the repo 116 | 2. Docker build 117 | 118 | ```bash 119 | docker build -t brave-search-mcp:latest -f ./Dockerfile . 120 | ``` 121 | 122 | 3. Add this to your `claude_desktop_config.json`: 123 | 124 | ```json 125 | { 126 | "mcp-servers": { 127 | "brave-search": { 128 | "command": "docker", 129 | "args": [ 130 | "run", 131 | "-i", 132 | "--rm", 133 | "-e", 134 | "BRAVE_API_KEY", 135 | "brave-search-mcp" 136 | ], 137 | "env": { 138 | "BRAVE_API_KEY": "YOUR API KEY HERE" 139 | } 140 | } 141 | } 142 | } 143 | ``` 144 | 145 | ### NPX 146 | 147 | Add this to your `claude_desktop_config.json`: 148 | 149 | ```json 150 | { 151 | "mcp-servers": { 152 | "brave-search": { 153 | "command": "npx", 154 | "args": [ 155 | "-y", 156 | "brave-search-mcp" 157 | ], 158 | "env": { 159 | "BRAVE_API_KEY": "YOUR API KEY HERE" 160 | } 161 | } 162 | } 163 | } 164 | ``` 165 | 166 | ### Usage with LibreChat 167 | 168 | Add this to librechat.yaml 169 | 170 | ```yaml 171 | brave-search: 172 | command: sh 173 | args: 174 | - -c 175 | - BRAVE_API_KEY=API KEY npx -y brave-search-mcp 176 | ``` 177 | 178 | ## Contributing 179 | 180 | Contributions are welcome! Please feel free to submit a Pull Request. 181 | 182 | ## Desktop Extensions (DXT) 183 | 184 | Anthropic recently released [Desktop Extensions](https://github.com/anthropics/dxt) allowing installation of local MCP Servers with one click. 185 | 186 | Install the CLI tool to help generate both `manifest.json` and final `.dxt` file. 187 | 188 | ```sh 189 | npm install -g @anthropic-ai/dxt 190 | ``` 191 | 192 | ### Creating the manifest.json file 193 | 194 | 1. In this folder/directory which contains the local MCP Server, run `dxt init`. The command will start an interactive CLI to help create the `manifest.json`. 195 | 196 | ### Creating the `dxt` file 197 | 198 | 1. First install dev dependencies and build 199 | 200 | ```sh 201 | npm install 202 | npm run build 203 | ``` 204 | 205 | 2. Then install only the production dependencies, generate a smaller nodule_modules directory 206 | 207 | ```sh 208 | npm install --omit=dev 209 | ``` 210 | 211 | 3. Run `dxt pack` to create a `dxt` file. This will also validate the manifest.json that was created. The `dxt` is essentially a zip file and will contain everything in this directory. 212 | 213 | ## Disclaimer 214 | 215 | This library is not officially associated with Brave Software. It is a third-party implementation of the Brave Search API with a MCP Server. 216 | 217 | ## License 218 | 219 | This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details. 220 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------