Skip to content

Add npm package metadata to mcp-server package.json - #106

Merged
JeremyDev87 merged 1 commit into
masterfrom
docs/99
Dec 23, 2025
Merged

Add npm package metadata to mcp-server package.json#106
JeremyDev87 merged 1 commit into
masterfrom
docs/99

Conversation

@JeremyDev87

Copy link
Copy Markdown
Owner

Add npm Package Metadata to MCP Server package.json

Summary

This PR adds essential npm package metadata fields to apps/mcp-server/package.json to ensure proper npm package distribution, discoverability, and compliance.

Closes #99

Changes

Modified

  • apps/mcp-server/package.json: Added npm package metadata fields
    • author: "JeremyDev87"
    • license: "MIT"
    • repository: GitHub repository object with directory field for monorepo structure
    • bugs: GitHub Issues URL
    • homepage: GitHub README URL
    • keywords: Array of 15 relevant npm search terms
    • description: Enhanced with more detailed text

Motivation

  • The publishable package lacked essential npm metadata
  • Missing repository field prevented npm from linking to source code
  • Missing bugs field made it harder for users to report issues
  • Missing homepage field reduced package visibility on npm
  • Missing license field could cause npm publish warnings
  • Missing author field affected package credibility
  • Missing keywords field reduced searchability on npm

Benefits

  • ✅ Enables proper npm package distribution without warnings
  • ✅ Improves package discoverability through keywords
  • ✅ Provides clear links to repository, issues, and homepage
  • ✅ Enhances package credibility with author and license information
  • ✅ Supports monorepo structure with repository.directory field
  • ✅ Follows npm best practices for package metadata

Implementation Details

Added Fields

Field Value
author "JeremyDev87"
license "MIT"
repository GitHub repository with directory: "apps/mcp-server"
bugs GitHub Issues URL
homepage GitHub README URL
keywords 15 relevant search terms (ai, mcp, coding-assistant, etc.)
description Enhanced description text

Repository Field Configuration

The repository.directory field is crucial for monorepo packages to correctly point to the package subdirectory:

"repository": {
  "type": "git",
  "url": "git+https://github.com/JeremyDev87/codingbuddy.git",
  "directory": "apps/mcp-server"
}

Keywords

Added 15 relevant keywords for npm searchability:

  • ai, mcp, model-context-protocol
  • coding-assistant, coding-rules, ai-rules
  • cursor, claude, claude-code, copilot, antigravity, amazon-q, kiro
  • developer-tools, nestjs

Testing

  • Verified all metadata fields are correctly added
  • Confirmed JSON syntax is valid
  • Checked repository.directory points to correct subdirectory
  • Validated all URLs are correct and accessible
  • Verified keywords array contains relevant search terms
  • npm publish --dry-run shows no metadata warnings (to be verified after merge)

Acceptance Criteria

  • author field is added
  • license field is set to "MIT"
  • repository object includes directory field pointing to "apps/mcp-server"
  • bugs URL points to GitHub issues
  • homepage URL points to repository
  • keywords array contains relevant npm search terms
  • npm publish --dry-run shows no metadata warnings (to be verified)
  • JSON is valid and properly formatted

Related

- Add author, license, repository fields
- Add bugs and homepage URLs
- Add keywords array for npm discoverability
- Update description with more detailed text
- Configure repository.directory for monorepo structure

close #99
@JeremyDev87 JeremyDev87 self-assigned this Dec 23, 2025
@JeremyDev87
JeremyDev87 marked this pull request as ready for review December 23, 2025 14:40
@JeremyDev87
JeremyDev87 merged commit 27fb4a7 into master Dec 23, 2025
9 checks passed
@JeremyDev87
JeremyDev87 deleted the docs/99 branch December 23, 2025 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Metadata to MCP Server package.json

2 participants