Specif Ai MCP Server

🚀 @vj-presidio/specif-ai-mcp-server Project Documentation

This project provides a server for handling specific AI-related requirements. It offers various tools to manage project paths and retrieve different types of requirement documents.

🚀 Quick Start

📦 Installation

You can install the @vj-presidio/specif-ai-mcp-server in the following ways:

Binary Installation using curl or PowerShell

• On Unix systems using curl:

curl -L https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-linux-amd64.tar.gz | tar xz && chmod +x specif-ai-mcp-server

• On Windows systems using PowerShell:

(New-Object System.Net.WebClient).DownloadFile('https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-win-amd64.zip', 'specif-ai-mcp-server.zip')
Expand-Archive specif-ai-mcp-server.zip

Installation using npm

npm install -g @vj-presidio/specif-ai-mcp-server

💻 Usage Examples

Setting the Project Path

Once the server is running, you can set the project folder path using the set-project-path tool. This tool takes a directory path containing specification files as a parameter. After setting the path, the server will load all documents in that directory.

Here is an example of using the tool:

{
  "name": "set-project-path",
  "arguments": {
    "path": "./path/to/project"
  }
}

List of Available Tools

📚 Project Path Setup Guide

Step 1: Download and Install the Tool

Choose the appropriate installation method based on your operating system:

• Linux/MacOS: Use the curl command to download and extract the binary file:

  curl -L https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-linux-amd64.tar.gz | tar xz && chmod +x specif-ai-mcp-server
  

• Windows: Use PowerShell to download and extract the binary file:

  (New-Object System.Net.WebClient).DownloadFile('https://github.com/vjpresidio/specif-ai-mcp-server/releases/download/v1.0.0/specif-ai-mcp-server-win-amd64.zip', 'specif-ai-mcp-server.zip')
  Expand-Archive specif-ai-mcp-server.zip
  

Step 2: Start the Server

After installation, run the following command in the terminal or command prompt to start the server:

specif-ai-mcp-server start

Step 3: Set the Project Path

Use the set-project-path tool to specify the directory containing specification files. For example, set the project path to ./specs:

specif-ai-mcp-server set-project-path --path ./specs

Verify the Configuration

After starting the server, you can run the following command to verify if the project documents are correctly loaded:

specif-ai-mcp-server get-brds

Additional Instructions

• Help Information: To view the help information of the tool, use the following command:

  specif-ai-mcp-server --help
  

• Version Information: To display the version information of the current tool:

  specif-ai-mcp-server --version
  

Integration and Extension

Supported Development Environments

1. Cline
2. Cursor

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file in the project for specific details.