0.2.2 • Published 5 months ago

@vj-presidio/specif-ai-mcp-server-test v0.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

@vj-presidio/specif-ai-mcp-server

A CLI tool that runs an MCP (Model Context Protocol) server over stdio for Specif-ai.

Installation & Usage Overview

graph TD
    A[Installation Options]

    A --> B[Direct Binary Installation]
    A --> C[Package Manager Installation]

    B --> D[Unix Script]
    B --> E[Windows PowerShell]

    C --> F[NPM Global]
    C --> G[Bun Global]

    B --> H1[When to Use Binary Installation]
    H1 --> I1[System-wide installation]
    H1 --> I2[No Node.js required]
    H1 --> I3[Fastest execution]
    H1 --> I4[Minimal dependencies]

    C --> H2[When to Use Package Manager]
    H2 --> J1[Already using Node.js/Bun]
    H2 --> J2[Need automatic updates]
    H2 --> J3[Project-specific versions]

    K[Usage Methods]
    K --> L[Direct CLI]
    K --> M[NPX]
    K --> N[BunX]

    L --> O1[Installed globally]
    L --> O2[Fastest startup]

    M --> P1[No installation needed]
    M --> P2[Version flexibility]

    N --> Q1[Bun runtime users]
    N --> Q2[Better performance]

Installation

Direct Binary Installation (Recommended)

You can install the binary directly using our installation script:

# Unix (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.sh | sh

# Install specific version
curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.sh | sh -s -- -v 1.2.3
# Windows (PowerShell)
iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.ps1 | iex

# Install specific version
iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/install.ps1 | iex -v 1.2.3

Package Manager Installation

You can install globally using npm:

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

Or using Bun:

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

Updates

To check for updates:

# Unix (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/update.sh | sh -s -- -c

# Windows (PowerShell)
iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/update.ps1 | iex -c

To update to the latest version:

# Unix (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/update.sh | sh

# Windows (PowerShell)
iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/update.ps1 | iex

To update to a specific version:

# Unix (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/update.sh | sh -s -- -v 1.2.3

# Windows (PowerShell)
iwr -useb https://raw.githubusercontent.com/vj-presidio/specif-ai-mcp-server/main/update.ps1 | iex -v 1.2.3

Usage

You can run the CLI directly if installed:

specif-ai-mcp-server

Or use it without installation via npx:

npx specif-ai-mcp-server

Or via bunx:

bunx specif-ai-mcp-server

Options

  • --help, -h: Display help information
  • --version: Display version information

Setting Project Path

Once the server is running, you can set the project path using the set-project-path tool. This tool accepts a path to the directory containing your specification files. After setting the path, the server will load all documents from that directory.

Example tool usage:

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

Available Tools

The server provides several tools for interacting with your specification documents:

Tool NameDescription
set-project-pathSet or change the project directory path
get-brdsGet Business Requirement Documents
get-prdsGet Product Requirement Documents
get-nfrsGet Non-Functional Requirements
get-uirsGet User Interface Requirements
get-bpsGet Business Process Documents
get-user-storiesGet User Stories for a specific PRD
get-tasksGet Tasks for a specific User Story
get-taskGet details of a specific Task

Requirements

For binary installation:

  • curl (Unix) or PowerShell (Windows)
  • sudo access (Unix, for system-wide installation)

For package manager installation:

  • Node.js >= 16.0.0
  • Bun >= 1.0.0 (if using Bun runtime)

License

MIT