@youdotcom-oss/mcp 1.3.4 → 1.3.5-next.5

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 (4) hide show
  1. package/AGENTS.md +64 -50
  2. package/README.md +1 -1
  3. package/bin/stdio.js +163 -164
  4. package/package.json +13 -14
package/AGENTS.md CHANGED
@@ -176,6 +176,66 @@ For detailed contribution guidelines, including:
176
176
 
177
177
  See [CONTRIBUTING.md](./CONTRIBUTING.md)
178
178
 
179
+ ## Publishing
180
+
181
+ ### Release Process
182
+
183
+ This package is published to npm via the `.github/workflows/publish-mcp.yml` workflow in the monorepo root.
184
+
185
+ **Workflow Actions**:
186
+ 1. Updates version in `packages/mcp/package.json`
187
+ 2. Scans all workspace packages for dependencies on `@youdotcom-oss/mcp`
188
+ 3. Updates dependent packages with exact version (e.g., "1.4.0")
189
+ 4. Commits all version updates together
190
+ 5. Creates GitHub release in private repo
191
+ 6. Syncs to OSS repo via git subtree split
192
+ 7. Creates GitHub release in OSS repo
193
+ 8. Publishes to npm
194
+
195
+ **Version Format**: Exact versions only (no `^` or `~` prefixes)
196
+
197
+ ```json
198
+ {
199
+ "dependencies": {
200
+ "@youdotcom-oss/mcp": "1.3.4"
201
+ }
202
+ }
203
+ ```
204
+
205
+ **IMPORTANT**: If you add dependencies on other workspace packages, use exact version numbers. The publish workflow will automatically keep them in sync when new versions are released.
206
+
207
+ ### Version Format Convention
208
+
209
+ This package follows standard Git tagging conventions:
210
+
211
+ - **Git tags**: `v{version}` (e.g., `v1.3.4`, `v1.4.0-next.1`)
212
+ - **GitHub releases**: `v{version}` (e.g., `Release v1.3.4`)
213
+ - **package.json**: `{version}` (no "v" prefix, e.g., `1.3.4`)
214
+ - **npm package**: `{version}` (no "v" prefix, e.g., `@youdotcom-oss/mcp@1.3.4`)
215
+
216
+ **When triggering the publish workflow:**
217
+ 1. Go to: Actions → Publish mcp-server Release → Run workflow
218
+ 2. Enter version WITHOUT "v" prefix: `1.3.4` (not `v1.3.4`)
219
+ 3. The workflow automatically adds "v" for Git tags
220
+ 4. Validation checks prevent common mistakes
221
+
222
+ **Example:**
223
+ ```bash
224
+ # Workflow input
225
+ Version: 1.3.4
226
+
227
+ # Produces:
228
+ # - Git tag: v1.3.4
229
+ # - package.json: "version": "1.3.4"
230
+ # - npm: @youdotcom-oss/mcp@1.3.4
231
+ # - Release: https://github.com/.../releases/tag/v1.3.4
232
+ ```
233
+
234
+ **Validation checks in workflow:**
235
+ - Rejects input with "v" prefix
236
+ - Verifies package.json matches release version
237
+ - Ensures no "v" prefix in package.json
238
+
179
239
  ## MCP Server Patterns
180
240
 
181
241
  ### Tool Registration
@@ -300,22 +360,6 @@ bun run build
300
360
  - Use `bun test --bail` to stop after first failure
301
361
  - Check your API key rate limits at [api.you.com](https://api.you.com)
302
362
 
303
- #### Docker Permission Issues
304
-
305
- **Symptom**: Docker build fails with permission errors
306
-
307
- **Solution**:
308
-
309
- ```bash
310
- # Ensure Docker daemon is running
311
- docker info
312
-
313
- # Build with sudo if needed (Linux)
314
- sudo docker build -t youdotcom-mcp-server .
315
-
316
- # Check Docker group membership (Linux)
317
- groups $USER
318
- ```
319
363
 
320
364
  #### Biome/TypeScript Errors
321
365
 
@@ -591,8 +635,8 @@ This section covers local development setup, self-hosting options, and productio
591
635
 
592
636
  ```bash
593
637
  # Clone repository
594
- git clone https://github.com/youdotcom-oss/youdotcom-mcp-server.git
595
- cd youdotcom-mcp-server
638
+ git clone https://github.com/youdotcom-oss/mcp-server.git
639
+ cd mcp-server
596
640
 
597
641
  # Install dependencies
598
642
  bun install
@@ -618,38 +662,9 @@ echo '{"jsonrpc":"2.0","method":"tools/list","id":1}' | bun src/stdio.ts
618
662
  curl http://localhost:4000/mcp-health
619
663
  ```
620
664
 
621
- ### Self-hosting with Docker
665
+ ### Self-hosting
622
666
 
623
- **Build and run:**
624
-
625
- ```bash
626
- # Build Docker image
627
- docker build -t youdotcom-mcp-server .
628
-
629
- # Run container with API key
630
- docker run -d \
631
- -p 4000:4000 \
632
- --name youdotcom-mcp \
633
- -e YDC_API_KEY=your-actual-api-key-here \
634
- youdotcom-mcp-server
635
-
636
- # Check health
637
- curl http://localhost:4000/mcp-health
638
- ```
639
-
640
- **Docker Compose:**
641
-
642
- ```yaml
643
- version: "3.8"
644
- services:
645
- youdotcom-mcp:
646
- build: .
647
- ports:
648
- - "4000:4000"
649
- environment:
650
- - YDC_API_KEY=${YDC_API_KEY}
651
- restart: unless-stopped
652
- ```
667
+ This package supports self-hosting in STDIO or HTTP modes (see deployment modes below).
653
668
 
654
669
  ### Deployment modes
655
670
 
@@ -659,7 +674,6 @@ services:
659
674
  | **STDIO Prod** | MCP client integration (local) | STDIO | `./bin/stdio.js` |
660
675
  | **HTTP Dev** | Local HTTP server testing | HTTP/SSE | `bun start` |
661
676
  | **HTTP Prod** | Remote clients, web apps, production | HTTP/SSE | `bun run build && bun bin/http` |
662
- | **Docker** | Containerized deployment | HTTP/SSE | `docker run ...` |
663
677
 
664
678
  ### Production deployment
665
679
 
package/README.md CHANGED
@@ -277,7 +277,7 @@ If you encounter a problem, you can report it via email or GitHub:
277
277
 
278
278
  **Web support:** [You.com Support](https://you.com/support/contact-us)
279
279
 
280
- **GitHub Issues:** [Report bugs and feature requests](https://github.com/youdotcom-oss/youdotcom-mcp-server/issues)
280
+ **GitHub Issues:** [Report bugs and feature requests](https://github.com/youdotcom-oss/mcp-server/issues)
281
281
 
282
282
  **Tip:** When errors occur, check your MCP client logs - they include a pre-filled mailto link with error details for easy reporting.
283
283