pub-mcp 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +58 -8
  3. package/dist/cli.js +1 -1
  4. package/package.json +9 -9
  5. package/src/cli.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ---
9
9
 
10
+ ## [0.2.0] - 2024-04-09
11
+
12
+ ### 🎉 Added
13
+
14
+ - **npx Support** - Now works without global installation!
15
+ - Users can use `npx -y pub-mcp` directly
16
+ - No need for global installation
17
+ - Works with any MCP client configuration
18
+
19
+ ### 📦 How to Use
20
+
21
+ ```json
22
+ {
23
+ "mcpServers": {
24
+ "pub-mcp": {
25
+ "command": "npx",
26
+ "args": ["-y", "pub-mcp"]
27
+ }
28
+ }
29
+ }
30
+ ```
31
+
32
+ ---
33
+
10
34
  ## [0.1.0] - 2024-04-09
11
35
 
12
36
  ### 🎉 Added
package/README.md CHANGED
@@ -11,15 +11,33 @@
11
11
 
12
12
  ## ⚡ Quick Start
13
13
 
14
+ ### Option 1: Install Globally
15
+
14
16
  ```bash
15
- # Install globally
16
17
  npm install -g pub-mcp
17
-
18
- # Start server (stdio + HTTP)
19
18
  pub-mcp
19
+ ```
20
20
 
21
- # Or start with just HTTP on custom port
22
- pub-mcp --http --port 8080
21
+ ### Option 2: Use npx (Recommended)
22
+
23
+ No installation required! Use directly in your MCP config:
24
+
25
+ ```json
26
+ {
27
+ "mcpServers": {
28
+ "pub-mcp": {
29
+ "command": "npx",
30
+ "args": ["-y", "pub-mcp"]
31
+ }
32
+ }
33
+ }
34
+ ```
35
+
36
+ ### Option 3: Local Installation
37
+
38
+ ```bash
39
+ npm install pub-mcp
40
+ npx pub-mcp
23
41
  ```
24
42
 
25
43
  That's it! Your MCP server is running on port 3000 (HTTP) and listening on stdio.
@@ -71,9 +89,28 @@ pub-mcp --health
71
89
 
72
90
  ### Connecting AI Clients
73
91
 
74
- #### Claude Desktop
92
+ #### Claude Desktop / VS Code / Cursor
93
+
94
+ Add to your MCP settings file:
75
95
 
76
- Add to your `claude_desktop_config.json`:
96
+ - **Claude Desktop**: `~/Library/Application Support/Claude/claude_desktop_config.json`
97
+ - **VS Code**: `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/Model Context Protocol/mcp_settings.json`
98
+ - **Cursor**: `[project root]/.cursor/mcp.json`
99
+
100
+ **Option 1: npx (Recommended - no installation needed)**
101
+
102
+ ```json
103
+ {
104
+ "mcpServers": {
105
+ "pub-mcp": {
106
+ "command": "npx",
107
+ "args": ["-y", "pub-mcp"]
108
+ }
109
+ }
110
+ }
111
+ ```
112
+
113
+ **Option 2: Global installation**
77
114
 
78
115
  ```json
79
116
  {
@@ -86,6 +123,19 @@ Add to your `claude_desktop_config.json`:
86
123
  }
87
124
  ```
88
125
 
126
+ **Option 3: Local installation**
127
+
128
+ ```json
129
+ {
130
+ "mcpServers": {
131
+ "pub-mcp": {
132
+ "command": "node",
133
+ "args": ["./node_modules/pub-mcp/dist/cli.js", "--stdio"]
134
+ }
135
+ }
136
+ }
137
+ ```
138
+
89
139
  #### Other MCP Clients
90
140
 
91
141
  ```bash
@@ -245,7 +295,7 @@ The `get_readme` tool supports a `format` parameter:
245
295
 
246
296
  ```bash
247
297
  # Clone and install
248
- git clone https://github.com/yourusername/pub-mcp.git
298
+ git clone https://github.com/testx1011/pub-mcp.git
249
299
  cd pub-mcp
250
300
  npm install
251
301
 
package/dist/cli.js CHANGED
@@ -11,7 +11,7 @@ import express from 'express';
11
11
  import cors from 'cors';
12
12
  import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
13
13
  const logger = pino({ level: process.env.LOG_LEVEL || 'info' });
14
- const VERSION = '0.1.0';
14
+ const VERSION = '0.2.0';
15
15
  const client = new PubClient();
16
16
  const githubClient = new GitHubClient();
17
17
  function createServer() {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pub-mcp",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "MCP server for pub.dev - Enables AI assistants to access Dart/Flutter package information",
5
5
  "main": "dist/cli.js",
6
6
  "type": "module",
@@ -9,11 +9,15 @@
9
9
  },
10
10
  "repository": {
11
11
  "type": "git",
12
- "url": "https://github.com/yourusername/pub-mcp.git"
12
+ "url": "git+https://github.com/testx1011/pub-mcp.git"
13
13
  },
14
- "homepage": "https://github.com/yourusername/pub-mcp#readme",
14
+ "homepage": "https://github.com/testx1011/pub-mcp#readme",
15
15
  "bugs": {
16
- "url": "https://github.com/yourusername/pub-mcp/issues"
16
+ "url": "https://github.com/testx1011/pub-mcp/issues"
17
+ },
18
+ "funding": {
19
+ "type": "github",
20
+ "url": "https://github.com/testx1011/pub-mcp"
17
21
  },
18
22
  "scripts": {
19
23
  "build": "tsc",
@@ -38,11 +42,7 @@
38
42
  "claude",
39
43
  "openai"
40
44
  ],
41
- "author": "Your Name <your@email.com>",
42
- "funding": {
43
- "type": "github",
44
- "url": "https://github.com/yourusername/pub-mcp"
45
- },
45
+ "author": "Jorge Armando Rivera <text.x1011@gmail.com>",
46
46
  "license": "MIT",
47
47
  "dependencies": {
48
48
  "@modelcontextprotocol/sdk": "^1.29.0",
package/src/cli.ts CHANGED
@@ -29,7 +29,7 @@ import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/
29
29
 
30
30
  const logger = pino({ level: process.env.LOG_LEVEL || 'info' });
31
31
 
32
- const VERSION = '0.1.0';
32
+ const VERSION = '0.2.0';
33
33
 
34
34
  const client = new PubClient();
35
35
  const githubClient = new GitHubClient();