An open API service indexing awesome lists of open source software.

https://github.com/presidio-oss/specifai-mcp-server

MCP server to provide Specifai project requirements, task, etc. to any AI tools supporting MCP such as Hai Build, Cursor.
https://github.com/presidio-oss/specifai-mcp-server

ai hai human-ai llm mcp presidio specifai specifai-mcp

Last synced: 3 months ago
JSON representation

MCP server to provide Specifai project requirements, task, etc. to any AI tools supporting MCP such as Hai Build, Cursor.

Awesome Lists containing this project

README

        

# 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.

> [!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.

[![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)

## Table of Contents

- [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)

## Installation

```bash
# Latest version
npx --yes @presidio-dev/specifai-mcp-server@latest

# Specific version
npx --yes @presidio-dev/[email protected]
```

We recommend `npx` to install the server, but you can use any node package manager of your preference such as `yarn`, `pnpm`, `bun`, etc.

## Configuration

with [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) with latest version:

```json
{
"specifai": {
"command": "npx",
"args": ["--yes", "@presidio-dev/specifai-mcp-server@latest"],
"disabled": false,
"autoApprove": []
}
}
```

with [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) with specific version:

```json
{
"specifai": {
"command": "npx",
"args": ["--yes", "@presidio-dev/[email protected]"],
"disabled": false,
"autoApprove": []
}
}
```

### Preparing your project

> 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.

The file is a plain text file containing the absolute path to the project directory where the specification documents for an project are stored.

For example, if your project directory is located at `/path/to/project`, the `.specifai-path` file should contain the following line:

```
/path/to/project
```

## Specifai MCP integration with popular IDE and extension

See the setup instructions for each

1. [Hai Build](./docs/setup/hai-build.md)
2. [Cursor](./docs/setup/cursor.md)

### Available Tools

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

| Tool Name | Description |
| ------------------ | ---------------------------------------- |
| `get-brds` | Get Business Requirement Documents |
| `get-prds` | Get Product Requirement Documents |
| `get-nfrs` | Get Non-Functional Requirements |
| `get-uirs` | Get User Interface Requirements |
| `get-bpds` | Get Business Process Documents |
| `get-user-stories` | Get User Stories for a specific PRD |
| `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)

## Contributing

We welcome contributions to the Specifai MCP Server! Please see our [Contributing Guide](CONTRIBUTING.md) for more information on how to get started.

### Development Setup

For detailed instructions on setting up your development environment, please refer to our [Development Setup Guide](docs/dev/02-development-setup.md).

### Architecture

To understand the project architecture, please see our [Architecture Guide](docs/dev/03-architecture-guide.md).

## Security

For information about our security policy and how to report security vulnerabilities, please see our [Security Policy](SECURITY.md).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgements

- [Model Context Protocol](https://modelcontextprotocol.io/) - The protocol specification this server implements
- [Specifai](https://github.com/presidio-oss/specifai) - The project this server integrates with