This package provides a Model Context Protocol server for integrating Linkup's web search functionality with AI models that support function calling through MCP.
You can run the Linkup MCP server directly using npx:
npx -y linkup-mcp --api-key=YOUR_LINKUP_API_KEY
Alternatively, you can set your API key as an environment variable:
export LINKUP_API_KEY=YOUR_LINKUP_API_KEY
npx -y linkup-mcp
Option | Description |
---|---|
--api-key |
Your Linkup API key (required unless LINKUP_API_KEY env is set) |
--base-url |
Custom API base URL (default: https://api.linkup.so/v1 ) |
--help, -h |
Show help text |
Add the following to your claude_desktop_config.json
. See the MCP documentation for more details.
To ensure compatibility with Claude, we recommend that npx
command be accessible within the same environment. A common location for this is /usr/local/bin/node
(on mac)
{
"mcpServers": {
"linkup": {
"command": "npx",
"args": ["-y", "linkup-mcp"],
"env": {
"LINKUP_API_KEY": "YOUR_LINKUP_API_KEY"
}
}
}
}
or
{
"mcpServers": {
"linkup": {
"command": "npx",
"args": ["-y", "linkup-mcp", "--api-key=YOUR_LINKUP_API_KEY"]
}
}
}
Tool | Description |
---|---|
search-web |
Perform a web search query using Linkup |
Clone the repository and install dependencies:
git clone [email protected]:LinkupPlatform/linkup-js-mcp.git
cd linkup-js-mcp
npm install
Script | Description |
---|---|
npm run build |
Build the TypeScript project |
npm run lint |
Run ESLint |
npm run format |
Format code with Prettier |
npm run test |
Run tests |
npm run test:watch |
Run tests in watch mode |
This project is licensed under the MIT License - see the LICENSE file for details.