volcengine-search-mcp-server
v0.0.5
Published
MCP Server for VolcEngine Web Search and Image Search
Maintainers
Readme
VolcEngine MCP Server
MCP (Model Context Protocol) Server for VolcEngine Web Search and Image Search APIs.
Features
- Web Search: Search web pages with various filtering options
- Image Search: Search images with size and shape filtering
- Easy to use: Simple CLI interface
- TypeScript support: Full type definitions
Installation
Global Installation (Recommended for CLI usage)
npm install -g volcengine-search-mcp-serverOr use npx directly:
npx volcengine-search-mcp --helpLocal Installation
npm install volcengine-search-mcp-serverUsage
CLI Usage
# Start the MCP server
npx volcengine-search-mcp
# With API Key
npx volcengine-search-mcp --api-key YOUR_API_KEY
# With custom port
npx volcengine-search-mcp --port 3000
# Show help
npx volcengine-search-mcp --helpEnvironment Variables
You can also set environment variables:
export VOLCENGINE_API_KEY=your_api_key
export VOLCENGINE_PORT=3000Then run:
npx volcengine-search-mcp-serverAPI Key
To use this MCP server, you need a VolcEngine API Key:
- Go to VolcEngine Console
- Navigate to "联网问答智能体-APIKey 管理"
- Click "融合信息搜索" and create an API Key
MCP Tools
This server provides the following MCP tools:
1. web_search
Search web pages with various options.
Parameters:
query(string, required): Search query (1-100 characters)count(number, optional): Number of results (1-50, default: 10)needContent(boolean, optional): Return only results with contentneedUrl(boolean, optional): Return only results with URLsites(string, optional): Specific sites to search (pipe-separated)blockHosts(string, optional): Sites to block (pipe-separated)needSummary(boolean, optional): Include precise summarytimeRange(string, optional): Time range: OneDay, OneWeek, OneMonth, OneYear, or date rangequeryRewrite(boolean, optional): Enable query rewriting
2. image_search
Search images with filtering options.
Parameters:
query(string, required): Search query (1-100 characters)count(number, optional): Number of results (1-5, default: 5)imageWidthMin(number, optional): Minimum image widthimageHeightMin(number, optional): Minimum image heightimageWidthMax(number, optional): Maximum image widthimageHeightMax(number, optional): Maximum image heightimageShapes(string[], optional): Allowed shapes: 横长方形, 竖长方形, 方形queryRewrite(boolean, optional): Enable query rewriting
Example Usage with Claude Desktop
Add this to your Claude Desktop configuration:
{
"mcpServers": {
"volcengine": {
"command": "npx",
"args": ["volcengine-search-mcp", "--api-key", "YOUR_API_KEY"]
}
}
}Development
Build from source
git clone <repository-url>
cd volcengine-search-mcp-server
npm install
npm run buildRun in development mode
npm run devLicense
MIT
