Skip to content

Add Metadata to MCP Server package.json #99

Description

@JeremyDev87

Add Metadata to MCP Server package.json

Summary

Add missing metadata fields to apps/mcp-server/package.json to ensure proper npm package distribution and discoverability.

Problem

  • The publishable package lacks essential npm metadata
  • Missing repository field prevents npm from linking to source code
  • Missing bugs field makes it harder for users to report issues
  • Missing homepage field reduces package visibility on npm
  • Missing license field may cause npm publish warnings
  • Missing author field affects package credibility
  • Missing keywords field reduces searchability on npm

Solution

Add the missing metadata fields to apps/mcp-server/package.json.

Implementation Details

File to Modify

Path: apps/mcp-server/package.json

Fields to Add

{
  "name": "codingbuddy",
  "version": "1.0.0",
  "description": "Multi-AI Rules MCP Server - One source of truth for AI coding rules across all AI assistants",
  "author": "JeremyDev87",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/JeremyDev87/codingbuddy.git",
    "directory": "apps/mcp-server"
  },
  "bugs": {
    "url": "https://github.com/JeremyDev87/codingbuddy/issues"
  },
  "homepage": "https://github.com/JeremyDev87/codingbuddy#readme",
  "keywords": [
    "ai",
    "mcp",
    "model-context-protocol",
    "coding-assistant",
    "cursor",
    "claude",
    "claude-code",
    "copilot",
    "antigravity",
    "amazon-q",
    "kiro",
    "coding-rules",
    "ai-rules",
    "developer-tools",
    "nestjs"
  ]
}

Changes Summary

Field Current New
description "Multi-AI Rules MCP Server" More descriptive text
author (missing) "JeremyDev87"
license (missing) "MIT"
repository (missing) GitHub repository object with directory
bugs (missing) GitHub issues URL
homepage (missing) GitHub README URL
keywords (missing) Array of relevant search terms

Note on Repository Field

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

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
  • JSON is valid and properly formatted

Labels

enhancement, npm

Priority

High - Required for proper npm package distribution

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions