@himanshu31shr/linkedin-mcp-server 1.0.0 → 1.0.1

package/README.md

@@ -1,8 +1,12 @@
 # LinkedIn MCP Server
 
+[![npm version](https://img.shields.io/npm/v/@himanshu31shr/linkedin-mcp-server.svg)](https://www.npmjs.com/package/@himanshu31shr/linkedin-mcp-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 A Model Context Protocol (MCP) server that provides AI agents with read/write access to the LinkedIn API.
 
 ## Features
+
 - **Profile Tools**: Fetch user profile and email.
 - **Post Tools**: Create text, link, image, and document posts. Delete posts.
 - **Media Tools**: Upload images and documents to LinkedIn.
@@ -10,35 +14,74 @@ A Model Context Protocol (MCP) server that provides AI agents with read/write ac
 - **Social Action Tools**: Fetch, create, and delete comments on posts. Add or remove reactions (like, celebrate, etc.).
 - **Organization Analytics Tools**: Get organization page, follower, and share statistics.
 
-## Setup
+## Prerequisites
 
-1. **Install dependencies**:
-   ```bash
-   npm install
-   ```
+You need a LinkedIn Access Token. Create an app on the [LinkedIn Developer Portal](https://developer.linkedin.com/), then either:
 
-2. **Build the project**:
-   ```bash
-   npm run build
-   ```
+- Use the built-in OAuth flow (see [Development Setup](#development-setup)), **or**
+- Generate a token manually from the developer portal.
+
+## Quick Start (npm — recommended)
+
+The easiest way to use this server is via the published npm package. No cloning required.
 
-3. **Get a LinkedIn Access Token**:
-   - Create an app on the [LinkedIn Developer Portal](https://developer.linkedin.com/).
-   - Go to the **Auth** tab and add `http://localhost:3000/callback` to the **Authorized redirect URLs**.
-   - Run the automated OAuth flow:
-     ```bash
-     npm run auth
-     ```
-   - Follow the prompts in the terminal. This will automatically open a browser window for you to log in and authorize the app, then it will save your new `LINKEDIN_ACCESS_TOKEN` directly into the `.env` file!
+### Install globally
 
-## Usage as a Local MCP Server
+```bash
+npm install -g @himanshu31shr/linkedin-mcp-server
+```
+
+Then run it:
+
+```bash
+LINKEDIN_ACCESS_TOKEN=your-token linkedin-mcp-server
+```
+
+### Or run directly with `npx`
 
-To use this server locally with an AI agent (like Claude Desktop, Cursor, or Antigravity), you need to configure the IDE to spawn the MCP server process.
+```bash
+LINKEDIN_ACCESS_TOKEN=your-token npx -y @himanshu31shr/linkedin-mcp-server
+```
+
+## MCP Client Configuration
 
-### Claude Desktop Configuration
+### Claude Desktop
 
 Add the following to your `claude_desktop_config.json`:
 
+**Using npx (no install needed):**
+
+```json
+{
+  "mcpServers": {
+    "linkedin": {
+      "command": "npx",
+      "args": ["-y", "@himanshu31shr/linkedin-mcp-server"],
+      "env": {
+        "LINKEDIN_ACCESS_TOKEN": "your-linkedin-access-token"
+      }
+    }
+  }
+}
+```
+
+**Using a global install:**
+
+```json
+{
+  "mcpServers": {
+    "linkedin": {
+      "command": "linkedin-mcp-server",
+      "env": {
+        "LINKEDIN_ACCESS_TOKEN": "your-linkedin-access-token"
+      }
+    }
+  }
+}
+```
+
+**Using a local clone:**
+
 ```json
 {
   "mcpServers": {
@@ -53,19 +96,107 @@ Add the following to your `claude_desktop_config.json`:
 }
 ```
 
-### Cursor Configuration
+### Cursor
 
 In Cursor's Settings > AI > MCP Servers, add a new server:
+
 - **Type**: `command`
 - **Name**: `linkedin`
-- **Command**: `node /path/to/linkedin-mcp-server/dist/index.js`
+- **Command**: `npx -y @himanshu31shr/linkedin-mcp-server`
 - **Environment Variables**: Add `LINKEDIN_ACCESS_TOKEN` with your token.
 
-## Development
+### Antigravity / Windsurf / Other MCP Clients
+
+Use the same pattern — point the MCP client to:
+
+```
+npx -y @himanshu31shr/linkedin-mcp-server
+```
+
+And set the `LINKEDIN_ACCESS_TOKEN` environment variable.
+
+## Available Tools
+
+| Tool | Description |
+|------|-------------|
+| `get_profile` | Fetch the authenticated user's LinkedIn profile |
+| `get_email` | Fetch the authenticated user's email address |
+| `create_text_post` | Create a text-only post |
+| `create_link_post` | Create a post with a link attachment |
+| `create_image_post` | Create a post with an image |
+| `create_document_post` | Create a post with a document (PDF, etc.) |
+| `delete_post` | Delete a post by URN |
+| `upload_image` | Upload an image to LinkedIn |
+| `get_organization` | Fetch organization details |
+| `create_org_post` | Create a post on behalf of an organization |
+| `get_org_posts` | Fetch recent posts for an organization |
+| `delete_org_post` | Delete an organization post |
+| `get_post_comments` | Fetch comments on a post |
+| `create_comment` | Add a comment to a post |
+| `delete_comment` | Delete a comment |
+| `add_reaction` | Add a reaction to a post |
+| `remove_reaction` | Remove a reaction from a post |
+| `get_org_page_statistics` | Get organization page statistics |
+| `get_org_follower_statistics` | Get organization follower statistics |
+| `get_org_share_statistics` | Get organization share statistics |
+
+## Development Setup
+
+If you want to contribute or run from source:
+
+1. **Clone and install**:
+   ```bash
+   git clone https://github.com/himanshu31shr/linkedin-mcp-server.git
+   cd linkedin-mcp-server
+   npm install
+   ```
+
+2. **Build**:
+   ```bash
+   npm run build
+   ```
+
+3. **Get a LinkedIn Access Token** (automated OAuth flow):
+   ```bash
+   npm run auth
+   ```
+   Follow the prompts — this will save your `LINKEDIN_ACCESS_TOKEN` to the `.env` file automatically.
+
+4. **Run locally**:
+   ```bash
+   npm run dev
+   ```
+
+## Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run build` | Compile TypeScript to JavaScript |
+| `npm run dev` | Run in development mode with `tsx` |
+| `npm run auth` | Run the OAuth token flow |
+| `npm test` | Run tests with Vitest |
+| `npm run test:coverage` | Run tests with coverage report |
+| `npm run lint` | Type-check with TypeScript |
+| `npm run inspect` | Launch MCP Inspector for debugging |
+
+## Releasing a New Version
+
+The CD pipeline automatically publishes to npm when a version tag is pushed.
+
+```bash
+# Bump version (creates commit + tag automatically)
+npm version patch   # or: npm version minor / npm version major
+
+# Push commit and tag to trigger publish
+git push origin main --tags
+```
+
+The pipeline will:
+1. Validate the tag matches `package.json` version
+2. Run lint, tests, and build
+3. Publish to npm with [provenance](https://docs.npmjs.com/generating-provenance-statements)
+4. Create a GitHub Release with auto-generated notes
+
+## License
 
-- `npm run build`: Compile TypeScript to JavaScript.
-- `npm run watch`: Compile in watch mode.
-- `npm test`: Run tests with Vitest.
-- `npm run test:ui`: Run tests with UI.
-- `npm run lint`: Run ESLint.
-- `npm run format`: Run Prettier.
+MIT

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@himanshu31shr/linkedin-mcp-server",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MCP server for LinkedIn API integration — compatible with all major AI IDEs",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
-    "linkedin-mcp-server": "./dist/index.js"
+    "linkedin-mcp-server": "dist/index.js"
   },
   "files": [
     "dist"