@presidio-dev/specifai-mcp-server 0.3.0 → 0.4.1

package/README.md

@@ -1,25 +1,34 @@
 # Specifai MCP Server
 
-A Model Context Protocol (MCP) server for [Specifai](https://github.com/presidio-oss/specifai) project integration and automation with any MCP-compatible AI tool. This server is designed to work with tool agnostic, meaning it can be used with any tool that supports the MCP protocol. This server currently expose tools to read all documents generated by Specifai project.
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm version](https://img.shields.io/npm/v/@presidio-dev/specifai-mcp-server.svg)](https://www.npmjs.com/package/@presidio-dev/specifai-mcp-server)
+[<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=plastic&label=Install&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode:mcp/install?{"name":"specifai","command":"npx","args":["-y","@presidio-dev/specifai-mcp-server@latest"]})
+[<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=plastic&label=Install&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders:mcp/install?{"name":"specifai","command":"npx","args":["-y","@presidio-dev/specifai-mcp-server@latest"]})
+[<img alt="Install in Cursor (npx)" src="https://img.shields.io/badge/Cursor-Cursor?style=plastic&label=Install&color=1A1A1A">](https://cursor.com/install-mcp?name=specifai&config=eyJjb21tYW5kIjoibnB4IC15IEBwcmVzaWRpby1kZXYvc3BlY2lmYWktbWNwLXNlcnZlckBsYXRlc3QifQ==)
 
-> [!WARNING]
-> This server is currently in experimental. The functionality and available tools are subject to change and expansion as we continue to develop and improve the server.
+A Model Context Protocol (MCP) server for [Specifai](https://github.com/presidio-oss/specifai) project integration and automation with any MCP-compatible AI tool. This server is designed to be tool-agnostic, meaning it can be used with any tool that supports the MCP protocol. This server currently exposes tools to read all documents generated by the Specifai project.
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![npm version](https://badge.fury.io/js/@presidio-dev%2Fspecif-ai-mcp-server.svg)](https://badge.fury.io/js/@presidio-dev%2Fspecif-ai-mcp-server)
+> [!WARNING]
+> This server is currently experimental. The functionality and available tools are subject to change and expansion as we continue to develop and improve the server.
 
 ## Table of Contents
 
+- [Requirements](#requirements)
 - [Installation](#installation)
 - [Configuration](#configuration)
 - [Preparing Your Project](#preparing-your-project)
 - [IDE Integration](#specifai-mcp-integration-with-popular-ide-and-extension)
 - [Available Tools](#available-tools)
-- [Requirements](#requirements)
 - [Contributing](#contributing)
 - [Security](#security)
 - [License](#license)
 
+## Requirements
+
+- Node.js >= 16.0.0
+- Bun >= 1.0.0 (if using Bun runtime)
+- Hai Build, Cursor, Windsurf, Claude Desktop or any MCP Client
+
 ## Installation
 
 ```bash
@@ -64,9 +73,9 @@ with [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) with specific version:
 
 > This is completely optional, but it's recommended to use it to avoid having to specify the project directory path every time you access the server. For AI IDE / Extension (Hai Build), it's recommended to use a `.specifai-path` file to specify the project directory path.
 
-Make sure your project root directory contains a `.specifai-path` file. It's how the Specifai MCP server know where to find the specification documents generated by Specifai.
+Make sure your project root directory contains a `.specifai-path` file. It's how the Specifai MCP server knows where to find the specification documents generated by Specifai.
 
-The file is a plain text file containing the absolute path to the project directory where the specification documents for an project are stored.
+The file is a plain text file containing the absolute path to the project directory where the specification documents for a project are stored.
 
 For example, if your project directory is located at `/path/to/project`, the `.specifai-path` file should contain the following line:
 
@@ -78,8 +87,129 @@ For example, if your project directory is located at `/path/to/project`, the `.s
 
 See the setup instructions for each
 
-1. [Hai Build](./docs/setup/hai-build.md)
-2. [Cursor](./docs/setup/cursor.md)
+<details>
+
+<summary><b>Install in Hai Build</b></summary>
+
+Add this to your Hai Build MCP configuration file. See [Hai Build MCP Wiki](https://github.com/presidio-oss/cline-based-code-generator/wiki#-mcp-servers) for more info.
+
+```json
+{
+  "mcpServers": {
+    "specifai": {
+      "command": "npx",
+      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+
+<summary><b>Install in Amazon Q Developer</b></summary>
+
+Add this to your Amazon Q Developer configuration file. See [MCP configuration for Q Developer in the IDE](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/mcp-ide.html#mcp-ide-configuration-add-server) for more details.
+
+```json
+{
+  "mcpServers": {
+    "specifai": {
+      "command": "npx",
+      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+
+<summary><b>Install in VS Code (Copilot)</b></summary>
+
+[<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=plastic&label=Install&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode:mcp/install?{"name":"specifai","command":"npx","args":["-y","@presidio-dev/specifai-mcp-server@latest"]})
+[<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=plastic&label=Install&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders:mcp/install?{"name":"specifai","command":"npx","args":["-y","@presidio-dev/specifai-mcp-server@latest"]})
+
+Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.
+
+```json
+"mcp": {
+  "servers": {
+    "specifai": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary><b>Install in Cursor</b></summary>
+
+Go to: `Settings` -> `Cursor Settings` -> `Tools & Integrations` -> `New MCP Server`
+
+Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.
+
+> Since Cursor 1.0, you can click the install button below for instant one-click installation.
+
+[<img alt="Install in Cursor (npx)" src="https://img.shields.io/badge/Cursor-Cursor?style=plastic&label=Install&color=1A1A1A">](https://cursor.com/install-mcp?name=specifai&config=eyJjb21tYW5kIjoibnB4IC15IEBwcmVzaWRpby1kZXYvc3BlY2lmYWktbWNwLXNlcnZlckBsYXRlc3QifQ==)
+
+```json
+{
+  "mcpServers": {
+    "specifai": {
+      "command": "npx",
+      "args": ["--yes", "@presidio-dev/specifai-mcp-server@latest"]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary><b>Install in Windsurf</b></summary>
+
+Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/cascade/mcp) for more info.
+
+```json
+{
+  "mcpServers": {
+    "specifai": {
+      "command": "npx",
+      "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary><b>Install in Zed</b></summary>
+
+Add this to your Zed `settings.json`. See [Add your own MCP server docs](https://zed.dev/docs/ai/mcp#add-your-own-mcp-server) for more info.
+
+```json
+{
+  "context_servers": {
+    "specifai": {
+      "command": {
+        "path": "npx",
+        "args": ["-y", "@presidio-dev/specifai-mcp-server@latest"]
+      },
+      "settings": {}
+    }
+  }
+}
+```
+
+</details>
 
 ### Available Tools
 
@@ -96,13 +226,9 @@ The server provides several tools for interacting with your specification docume
 | `get-tasks`        | Get Tasks for a specific User Story      |
 | `get-task`         | Get details of a specific Task           |
 | `set-project-path` | Set or change the project directory path |
-
-## Requirements
-
-Package manager installation:
-
-- Node.js >= 16.0.0
-- Bun >= 1.0.0 (if using Bun runtime)
+| `get-task-by-id`   | Get details of a specific Task by ID     |
+| `list-all-tasks`   | List all available tasks                 |
+| `search`           | Full text search across all documents    |
 
 ## Contributing