Skip to content

Commit a64f2e7

Browse files
vprudnikoffvprudnikoff
authored
Update README.md
1 parent b17c098 commit a64f2e7

File tree

1 file changed

+118
-68
lines changed

1 file changed

+118
-68
lines changed

‎README.md‎

Lines changed: 118 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
1-
# Linked API MCP Server
1+
[Linked API](https://linkedapi.io/?ref=linkedapi-mcp) MCP server connects your LinkedIn account to AI assistants like Claude, Cursor, and VS Code. Ask them to search for leads, send messages, analyze profiles, and much more – they'll handle it through our cloud browser, safely and automatically.
22

3-
Model Context Protocol (MCP) server for [Linked API](https://linkedapi.io).
3+
# Use cases
4+
- **Sales automation assistant**. Ask your AI to find leads, check their profiles, and draft personalized outreach. It can search for "software engineers at companies with 50-200 employees in San Francisco", analyze their backgrounds, and suggest connection messages that actually make sense.
5+
- **Recruitment assistant**. Let your assistant search for candidates with specific skills, review their experience, and send initial outreach. It handles the time-consuming parts while you focus on actually talking to people.
6+
- **Conversation assistant**. Your AI can read your existing LinkedIn conversations and help you respond naturally. It understands the context of your chats, suggests relevant replies, and can even send follow-up messages.
7+
- **Market research assistant**. Need competitor analysis? Your assistant can gather data about companies, their employees, and recent activities. Get insights about industry trends without spending hours on LinkedIn.
48

5-
## Installation
9+
# Installation
10+
The MCP server needs tokens to access your LinkedIn account. Here's how to get them:
611

7-
### Get API Tokens
12+
1. Sign up at [Linked API Platform](https://app.linkedapi.io/?ref=github-mcp).
13+
2. Choose your plan and complete the purchase.
14+
3. Connect your LinkedIn account (it takes about 2 minutes).
15+
4. Copy your tokens from the dashboard:
16+
- `LINKED_API_TOKEN` – your main token that enables Linked API access.
17+
- `IDENTIFICATION_TOKEN` – unique token for your LinkedIn account.
18+
19+
**Multiple LinkedIn accounts:**
820

9-
1. Sign up at [Linked API](https://app.linkedapi.io?ref=linkedapi-mcp)
10-
2. Get your **LINKED_API_TOKEN** and **IDENTIFICATION_TOKEN** from the dashboard
21+
If you have multiple LinkedIn accounts, you'll get a separate identification token for each one, and you can create multiple MCP server instances – one for each account.
1122

12-
### Workflow Behavior
23+
**Handling long-running workflows:**
1324

14-
Linked API workflows can take over 5 minutes to complete, which might cause the MCP client to disconnect before the results are ready. To address this, each tool invocation includes a `HEALTH_CHECK_PERIOD`— timeout setting in seconds, defaulting to 60 seconds. Once this period elapses, the MCP server will provide a response instructions for workflow restoration.
25+
The configuration examples below include a `HEALTH_CHECK_PERIOD` variable. Different applications (Claude, VS Code, Cursor, Windsurf) have different timeout limits for MCP tool calls. Since some LinkedIn workflows can take several minutes to complete, this setting helps the MCP server handle these longer operations correctly – preventing disconnections and ensuring your workflows run to completion.
1526

16-
You can find recommended `HEALTH_CHECK_PERIOD` values for different MCP clients in examples below.
27+
## Claude
1728

18-
### Claude Desktop
29+
Add this to your Claude Desktop configuration file:
30+
31+
- Mac: `~/Library/Application Support/Claude/claude_desktop_config.json`
32+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
1933

2034
```json
2135
{
@@ -32,9 +46,10 @@ You can find recommended `HEALTH_CHECK_PERIOD` values for different MCP clients
3246
}
3347
}
3448
```
49+
Restart Claude Desktop after saving the config.
3550

36-
### Cursor
37-
51+
## Cursor
52+
Add this configuration to your Cursor settings:
3853
```json
3954
{
4055
"mcpServers": {
@@ -50,63 +65,98 @@ You can find recommended `HEALTH_CHECK_PERIOD` values for different MCP clients
5065
}
5166
}
5267
```
68+
You can also configure it through the UI: go to Cursor Settings > Tools & Integrations > MCP Tools Section, then click "New MCP Server" and paste the configuration.
5369

54-
## Example Usage
55-
56-
After setup, you can ask Claude or Cursor:
57-
58-
> "Find software engineers at Google in San Francisco"
59-
60-
> "Get the profile information for linkedin.com/in/john-doe"
61-
62-
> "Send a connection request to this person with a personalized note"
63-
64-
65-
<details>
66-
<summary><b>Available Tools</b></summary>
67-
68-
Standard tools:
69-
- `fetch_person` - Get LinkedIn profile information with optional experience, education, skills, posts
70-
- `fetch_company` - Get company information with optional employees, decision makers, posts
71-
- `fetch_post` - Get post data and engagement metrics
72-
- `search_people` - Search for people with advanced filtering
73-
- `search_companies` - Search for companies with advanced filtering
74-
- `send_message` - Send direct messages to connections
75-
- `sync_conversation` - Sync conversation for polling
76-
- `poll_conversations` - Monitor multiple conversations for new messages
77-
- `send_connection_request` - Send connection requests with optional notes
78-
- `check_connection_status` - Check connection status with someone
79-
- `withdraw_connection_request` - Withdraw pending connection requests
80-
- `retrieve_pending_requests` - Get all pending connection requests
81-
- `retrieve_connections` - Get your connections with filtering
82-
- `remove_connection` - Remove someone from connections
83-
- `react_to_post` - React to posts (like, love, support, celebrate, insightful, funny)
84-
- `comment_on_post` - Leave comments on posts
85-
- `retrieve_ssi` - Get your Social Selling Index score
86-
- `retrieve_performance` - Get LinkedIn dashboard analytics
87-
- `get_api_usage_stats` - Get Linked API usage statistics
88-
89-
Sales Navigator tools
90-
- `nv_search_people` - Advanced people search with Sales Navigator filters
91-
- `nv_search_companies` - Advanced company search with revenue filters
92-
- `nv_fetch_person` - Get enhanced person data via Sales Navigator
93-
- `nv_fetch_company` - Get enhanced company data with employees and decision makers
94-
- `nv_send_message` - Send InMail messages with subject lines
95-
- `nv_sync_conversation` - Sync Sales Navigator conversations
96-
97-
Advanced tools
98-
- `execute_custom_workflow` - Execute custom workflow definitions
99-
- `get_workflow_result` - Get workflow results by ID
100-
- `restore_workflow` - Restores workflow after timeout or shut down
101-
102-
</details>
103-
104-
## Troubleshooting
70+
## VS Code
71+
Install the MCP extension, then add this to your settings:
72+
```json
73+
{
74+
"mcpServers": {
75+
"linkedapi": {
76+
"command": "npx",
77+
"args": ["-y", "linkedapi-mcp@latest"],
78+
"env": {
79+
"LINKED_API_TOKEN": "your-linked-api-token-here",
80+
"IDENTIFICATION_TOKEN": "your-identification-token-here",
81+
"HEALTH_CHECK_PERIOD": "600"
82+
}
83+
}
84+
}
85+
}
86+
```
10587

106-
- Restart Claude Desktop/Cursor after configuration changes
107-
- Verify your API tokens are valid at [Linked API Dashboard](https://app.linkedapi.io)
108-
- Check that the configuration file syntax is correct
88+
## Windsurf
89+
Add this to your Windsurf configuration file at `~/.codeium/windsurf/mcp_config.json`:
10990

110-
## License
91+
```json
92+
{
93+
"mcpServers": {
94+
"linkedapi": {
95+
"command": "npx",
96+
"args": ["-y", "linkedapi-mcp@latest"],
97+
"env": {
98+
"LINKED_API_TOKEN": "your-linked-api-token-here",
99+
"IDENTIFICATION_TOKEN": "your-identification-token-here",
100+
"HEALTH_CHECK_PERIOD": "600"
101+
}
102+
}
103+
}
104+
}
105+
```
106+
You can also configure it through the UI: go to Windsurf Settings > Advanced Settings > Cascade section, then click "Add Server" and paste the configuration.
107+
108+
# Available tools
109+
The MCP server provides these tools for interacting with LinkedIn:
110+
111+
## Standard interface
112+
| **Tool** | **Description** |
113+
|:---------|----------:|
114+
| `fetch_person` | Get person page information with optional experience, education, skills, posts |
115+
| `fetch_company` | Get company information with optional employees, decision makers, posts |
116+
| `fetch_post` | Get post information and engagement metrics |
117+
| `search_people` | Search for people with advanced filtering |
118+
| `search_companies` | Search for companies with advanced filtering |
119+
| `send_message` | Send message to person |
120+
| `sync_conversation` | Sync conversation for polling |
121+
| `send_connection_request` | Send connection request with optional note |
122+
| `check_connection_status` | Check connection status with person |
123+
| `withdraw_connection_request` | Withdraw pending connection request |
124+
| `retrieve_pending_requests` | Get all pending connection requests |
125+
| `retrieve_connections` | Get your connections with filtering |
126+
| `remove_connection` | Remove person from connections |
127+
| `react_to_post` | React to post (like, love, support, celebrate, insightful, funny) |
128+
| `comment_on_post` | Leave comment on post |
129+
| `retrieve_performance` | Get LinkedIn dashboard analytics |
130+
| `get_api_usage_stats` | Get Linked API usage statistics |
131+
132+
## Sales Navigator
133+
| **Tool** | **Description** |
134+
|:---------|----------:|
135+
| `nv_fetch_person` | Get person page information from Sales Navigator |
136+
| `nv_fetch_company` | Get company information with optional employees and decision makers from Sales Navigator |
137+
| `nv_search_people` | Search for people with advanced filtering via Sales Navigator |
138+
| `nv_search_companies` | Search for companies with advanced filtering via Sales Navigator |
139+
| `nv_send_message` | Send message to person via Sales Navigator |
140+
| `nv_sync_conversation` | Sync Sales Navigator conversation for polling |
141+
142+
## Other tools
143+
| **Tool** | **Description** |
144+
|:---------|----------:|
145+
| `poll_conversations` | Monitor Standard and Sales Navigator conversations for new messages |
146+
| `execute_custom_workflow` | Execute custom workflow definition |
147+
| `get_workflow_result` | Get workflow result by ID |
148+
149+
# Usage examples
150+
With Linked API MCP, you can ask your AI-assistant things like:
151+
> Find all decision makers at Acme Corp and send them connection requests.
152+
153+
> Search for product managers at fintech companies in New York with 50-200 employees.
154+
155+
> Tell me about 'https[]()://linkedin.com/in/jane-doe' including their work history and experience.
156+
157+
> Send a connection request to 'https[]()://linkedin.com/in/jane-doe' mentioning their recent article about AI in healthcare.
158+
159+
> Get all my pending connection requests and withdraw each one of them.
160+
161+
These are just basic examples. Since your assistant can execute custom workflows combining multiple actions, the automation potential is truly limitless.
111162

112-
MIT

0 commit comments

Comments
 (0)