Skip to content

Use correct npx command inside the README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2025
Merged

Use correct npx command inside the README.md #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@

This package provides a [Model Context Protocol](https://modelcontextprotocol.com/) server for integrating Linkup's web search functionality with AI models that support function calling through MCP.

You can check the NPM page [here](https://www.npmjs.com/package/linkup-mcp-server).

## Installation & Usage

You can run the Linkup MCP server directly using npx:

```bash
npx -y linkup-mcp --api-key=YOUR_LINKUP_API_KEY
npx -y linkup-mcp-server --api-key=YOUR_LINKUP_API_KEY
```

Alternatively, you can set your API key as an environment variable:

```bash
export LINKUP_API_KEY=YOUR_LINKUP_API_KEY
npx -y linkup-mcp
npx -y linkup-mcp-server
```

# Command Line Options
Expand All @@ -36,7 +38,7 @@ To ensure compatibility with Claude, we recommend that `npx` command be accessib
"mcpServers": {
"linkup": {
"command": "npx",
"args": ["-y", "linkup-mcp"],
"args": ["-y", "linkup-mcp-server"],
"env": {
"LINKUP_API_KEY": "YOUR_LINKUP_API_KEY"
}
Expand All @@ -52,7 +54,7 @@ or
"mcpServers": {
"linkup": {
"command": "npx",
"args": ["-y", "linkup-mcp", "--api-key=YOUR_LINKUP_API_KEY"]
"args": ["-y", "linkup-mcp-server", "--api-key=YOUR_LINKUP_API_KEY"]
}
}
}
Expand All @@ -69,8 +71,8 @@ or
Clone the repository and install dependencies:

```bash
git clone git@github.com:LinkupPlatform/linkup-js-mcp.git
cd linkup-js-mcp
git clone git@github.com:LinkupPlatform/js-mcp-server.git
cd js-mcp-server
npm install
```

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.