mcp-udacity-commit 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Muzaffar Qosimov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,18 +1,17 @@
 # mcp-udacity-commit
 
+[![npm version](https://img.shields.io/npm/v/mcp-udacity-commit)](https://www.npmjs.com/package/mcp-udacity-commit)
+[![npm downloads](https://img.shields.io/npm/dm/mcp-udacity-commit)](https://www.npmjs.com/package/mcp-udacity-commit)
+[![License: MIT](https://img.shields.io/npm/l/mcp-udacity-commit)](./LICENSE)
+[![MCP](https://img.shields.io/badge/MCP-server-blue)](https://modelcontextprotocol.io)
+
 An [MCP](https://modelcontextprotocol.io) server that validates and formats git
 commit messages according to the
 [Udacity Git Commit Message Style Guide](https://udacity.github.io/git-styleguide/).
 
-## What it exposes
-
-| Primitive | Name | Purpose |
-| --- | --- | --- |
-| Resource | `udacity://commit-styleguide` | The style-guide rules, as markdown |
-| Tool | `validate_commit_message` | Checks a message against every rule (type, ≤50-char subject, capitalization, no trailing period, blank line, ≤72-char body wrap) |
-| Tool | `format_commit_message` | Builds a compliant message from `type` + `subject` + optional `body`/`footer` |
+## Install
 
-## Install (published package)
+One line — paste it into your terminal:
 
 ```bash
 claude mcp add udacity-commit -- npx -y mcp-udacity-commit
@@ -31,7 +30,8 @@ For Claude Desktop, add to `claude_desktop_config.json`:
 }
 ```
 
-## Install from source
+<details>
+<summary>Install from source</summary>
 
 ```bash
 git clone https://github.com/qwertymuzaffar/mcp-udacity-commit
@@ -41,6 +41,43 @@ npm run build
 claude mcp add udacity-commit -- node "$(pwd)/build/index.js"
 ```
 
+</details>
+
+## What it exposes
+
+| Primitive | Name | Purpose |
+| --- | --- | --- |
+| Resource | `udacity://commit-styleguide` | The style-guide rules, as markdown |
+| Tool | `validate_commit_message` | Checks a message against every rule (type, ≤50-char subject, capitalization, no trailing period, blank line, ≤72-char body wrap) |
+| Tool | `format_commit_message` | Builds a compliant message from `type` + `subject` + optional `body`/`footer` |
+
+## Example
+
+`format_commit_message` turns loose parts into a compliant commit:
+
+```text
+in:  type=fix  subject="prevent duplicate auth token refresh."
+     body="The refresh timer could fire twice under load, minting two tokens…"
+     footer="Resolves: #142"
+
+out:
+fix: Prevent duplicate auth token refresh
+
+The refresh timer could fire twice under load, minting two tokens and
+logging the user out. Serialize refreshes behind a single in-flight
+promise so concurrent callers await the same request.
+
+Resolves: #142
+```
+
+`validate_commit_message` flags every violation:
+
+```text
+"Fixed the login bug."  →  ❌ Not compliant.
+  • Subject must follow "type: Subject".
+  • Subject must not end with a period.
+```
+
 ## Develop
 
 ```bash
@@ -49,17 +86,6 @@ npm run build          # → build/index.js
 npm run test:client    # spawns the server and exercises the tools
 ```
 
-## Publish
-
-```bash
-# 1. npm
-npm publish --access public
-
-# 2. MCP Registry (after npm publish)
-mcp-publisher login github
-mcp-publisher publish
-```
-
 ## License
 
 MIT

package/build/index.js

@@ -111,7 +111,7 @@ function validate(message) {
     }
     return { valid: problems.length === 0, problems, warnings };
 }
-const server = new McpServer({ name: "udacity-commit", version: "1.0.0" });
+const server = new McpServer({ name: "udacity-commit", version: "1.0.1" });
 server.registerResource("styleguide", "udacity://commit-styleguide", {
     title: "Udacity Git Commit Style Guide",
     description: "The commit-message rules (types, subject, body, footer).",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-udacity-commit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MCP server that validates and formats git commit messages per the Udacity Git Commit Message Style Guide.",
   "type": "module",
   "license": "MIT",