git-mob-mcp-server 1.0.10 → 1.0.11

package/README.md

@@ -1,12 +1,17 @@
 # Git Mob MCP Server
 
-![NPM Version](https://img.shields.io/npm/v/git-mob-mcp-server)
-![CI Release](https://github.com/Mubashwer/git-mob-mcp-server/actions/workflows/ci-release.yml/badge.svg)
+[![NPM Version](https://img.shields.io/npm/v/git-mob-mcp-server)](https://www.npmjs.com/package/git-mob-mcp-server)
+[![CI Release](https://github.com/Mubashwer/git-mob-mcp-server/actions/workflows/ci-release.yml/badge.svg)](https://github.com/Mubashwer/git-mob-mcp-server/actions/workflows/ci-release.yml)
 [![codecov](https://codecov.io/gh/Mubashwer/git-mob-mcp-server/graph/badge.svg?token=21GJOEYQGG)](https://codecov.io/gh/Mubashwer/git-mob-mcp-server)
-![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/Mubashwer/git-mob-mcp-server/blob/main/LICENSE)
 
 Node.js server implementing Model Context Protocol (MCP) for [`git mob` CLI app](https://github.com/Mubashwer/git-mob)
 
+*You can attribute a git commit to more than one author by adding one or more Co-authored-by trailers to the commit's message. Co-authored commits are visible on GitHub.
+For more information, see [here](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors).*
+
+This MCP Server will help you add them automatically and also help you store and manage co-authors for pair/mob programming sessions.
+
 Built using [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/typescript-sdk)
 
 ## Features
@@ -16,25 +21,33 @@ Built using [@modelcontextprotocol/sdk](https://github.com/modelcontextprotocol/
 - Choose team members for pairing / mobbing session
 - Automatic appending of Co-authored-by in for co-authors in commit messages during pairing / mobbing session
 
+## Prerequisites
+
+### System Requirements
+
+- **Node.js**: Version 18 or higher
+- **git**: Git v2.32 or later must be installed and configured
+- **git-mob CLI**: [git-mob CLI app](https://github.com/Mubashwer/git-mob?tab=readme-ov-file#installation) must be installed
+
 ## API
 
 ### Resources
 
-- `git_mob_help`: General help and usage information for the Git Mob CLI.
-- `git_mob_version`: The installed version of the Git Mob CLI.
+- `git_mob_cli_help`: General help and usage information for the Git Mob CLI.
+- `git_mob_cli_version`: The installed version of the Git Mob CLI.
 
 ### Tools
 
-- `git_mob_help`: Displays general help and usage information for the Git Mob CLI.
+- `git_mob_cli_help`: Displays general help and usage information for the Git Mob CLI.
 - `setup_git_mob_globally`: Sets up git-mob globally for the user.
-- `setup_git_mob_locally`: Sets up git-mob locally for the current repository.
+- `setup_git_mob_locally`: Sets up git-mob locally for the current repository when it overrides `core.hooksPath` git configuration variable (e.g when using husky).
 - `add_team_member`: Adds a new team member using their key, name, and email.
 - `delete_team_member`: Deletes a team member by their key.
 - `list_team_members`: Lists all team members that have been added to Git Mob.
 - `set_mob_session_coauthors`: Sets the active pairing or mob session by specifying the keys of the team members to include as coauthors.
 - `clear_mob_session`: Clears the active mob or pairing session.
 - `list_mob_session_coauthors`: Lists all coauthors currently included in the active mob or pairing session.
-- `list_mob_session_coauthors` (trailers): Lists the git Co-authored-by trailers for the coauthors currently included in the active mob or pairing session.
+- `list_mob_session_coauthor_trailers`: Lists the git Co-authored-by trailers for the coauthors currently included in the active mob or pairing session.
 
 ## Usage with Claude Desktop
 
@@ -76,6 +89,40 @@ Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace
 }
 ```
 
+## Setup
+
+Run the `setup_git_mob_globally` MCP tool once to configure git-mob globally for all repositories
+
+## Local Development
+
+For local development and testing of the MCP server:
+
+1. **Clone the repository**:
+
+   ```bash
+   git clone https://github.com/Mubashwer/git-mob-mcp-server.git
+   cd git-mob-mcp-server
+   ```
+
+2. **Install dependencies**:
+
+   ```bash
+   npm install
+   ```
+
+3. **Start development server**:
+
+   ```bash
+   npm start
+   ```
+
+   This command will:
+
+   - Build the TypeScript source code in watch mode (automatically rebuilds on file changes)
+   - Start the MCP Inspector for testing and debugging the server locally
+
+The MCP Inspector will be available at the URL shown in the terminal output, allowing you to test the server's tools and resources interactively.
+
 ## License
 
 This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

package/dist/gitMobServerFactory.js

@@ -13,9 +13,9 @@ export const createGitMobServer = () => {
             resources: {},
         },
     });
-    registerGitMobResourceTemplate(server, resourceTemplates.gitMobHelp);
-    registerGitMobResource(server, resources.gitMobVersion);
-    registerGitMobTool(server, tools.getGitMobHelp);
+    registerGitMobResourceTemplate(server, resourceTemplates.gitMobCliHelp);
+    registerGitMobResource(server, resources.gitMobCliVersion);
+    registerGitMobTool(server, tools.getGitMobCliHelp);
     registerGitMobTool(server, tools.setupGitMobGlobally);
     registerGitMobTool(server, tools.setupGitMobLocally);
     registerGitMobTool(server, tools.addTeamMember);

package/dist/resourceTemplates/{gitMobHelp.js → gitMobCliHelp.js}

@@ -1,7 +1,7 @@
 import { ResourceTemplate, } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { getHelp } from "../clients/gitMobClient.js";
 import { UriTemplate } from "@modelcontextprotocol/sdk/shared/uriTemplate.js";
-const name = "git_mob_help";
+const name = "git_mob_cli_help";
 const template = new ResourceTemplate(new UriTemplate("gitmob://help{?command}"), {
     list: undefined,
     complete: {

package/dist/resourceTemplates/index.js

@@ -1 +1 @@
-export { default as gitMobHelp } from "./gitMobHelp.js";
+export { default as gitMobCliHelp } from "./gitMobCliHelp.js";

package/dist/resources/{gitMobVersion.js → gitMobCliVersion.js}

@@ -1,6 +1,6 @@
 import {} from "@modelcontextprotocol/sdk/server/mcp.js";
 import { getVersion } from "../clients/gitMobClient.js";
-const name = "git_mob_version";
+const name = "git_mob_cli_version";
 const uri = "gitmob://version";
 const metadata = {
     description: "The installed version of the Git Mob CLI.",

package/dist/resources/index.js

@@ -1 +1 @@
-export { default as gitMobVersion } from "./gitMobVersion.js";
+export { default as gitMobCliVersion } from "./gitMobCliVersion.js";

package/dist/tools/{getGitMobHelp.js → getGitMobCliHelp.js}

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { getHelp } from "../clients/gitMobClient.js";
-const name = "get_git_mob_help";
+const name = "git_mob_cli_help";
 const description = "Displays general help and usage information for the Git Mob CLI. " +
     "You can optionally provide a command ('setup', 'coauthor', or 'help') " +
     "to get detailed help for that specific command.";

package/dist/tools/index.js

@@ -1,4 +1,4 @@
-export { default as getGitMobHelp } from "./getGitMobHelp.js";
+export { default as getGitMobCliHelp } from "./getGitMobCliHelp.js";
 export { default as setupGitMobGlobally } from "./setupGitMobGlobally.js";
 export { default as setupGitMobLocally } from "./setupGitMobLocally.js";
 export { default as addTeamMember } from "./addTeamMember.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-mob-mcp-server",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "MCP Server for git-mob CLI app",
   "main": "dist/index.js",
   "type": "module",