Git-Spice Documentation Search MCP server

This repository provides a Model Context Protocol (MCP) server implementation that enables searching git-spice documentation directly within the Cursor IDE. The server leverages the MCP protocol to seamlessly integrate documentation search capabilities into your development workflow.

Prerequisites

• Node.js (v16 or higher)
• Cursor IDE
• npm or yarn package manager

Installation

1. Clone the repository and navigate to the project directory:

   git clone <repository-url>
   cd <repository-name>
   

2. Install the required dependencies:

   npm install
   # or
   yarn install
   

3. Build the project:

   npm run build
   # or
   yarn build
   

Configuration

Server Configuration

The MCP server comes pre-configured with the following capabilities:

• Tools capability
• Resources capability
• Prompts capability

Cursor IDE Configuration

1. Open Cursor IDE settings:

   • On macOS: Cmd + ,
   • On Windows/Linux: Ctrl + ,

2. Navigate to the "Extensions" section

3. Find the MCP Server settings and add a new server configuration:

   {
     "name": "Git Spice MCP Server",
     "command": "node",
     "args": ["dist/index.js"],
     "cwd": "/path/to/your/project"
   }
   

4. Save the settings and refresh the MCP

Usage

Once properly configured, the MCP server will be automatically detected when using Cursor in agent mode. The git-spice documentation search tool will then be available through the Cursor interface.

When you're working on tasks that might benefit from git-spice documentation, the agent will automatically suggest using the tool to find relevant information. This integration allows you to access documentation without leaving your development environment.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.