Intent MCP Server

🚀 Intent MCP Server

An Model Context Protocol (MCP) server that processes natural language intents and transforms them into a structured, executable format. This server offers a powerful and reliable API for managing and processing intents, with a focus on scalability and reliability.

🚀 Quick Start

The Intent MCP Server is designed to handle natural language intents and convert them into a structured, executable format. It provides a robust API for intent management, emphasizing scalability and reliability.

✨ Features

• 🎯 Intent Processing: Create, retrieve, and process intents.
• 🔍 Natural Language Understanding: Parse and comprehend the user's original intent.
• 🧩 Intent Decomposition: Transform intents into structured objects containing goals and constraints.
• 💾 Flexible Storage: A pluggable storage system with an in-memory implementation.
• 📝 Type Safety: Fully implemented in TypeScript with comprehensive type definitions.
• 🛡️ Error Handling: A powerful error handling and logging system.
• 🧪 Testing: A comprehensive test suite using Jest.
• 📚 API Documentation: Clear API documentation and examples.

📦 Installation

Prerequisites

• Node.js (v18 or higher)
• npm or yarn

Steps

1. Clone the repository:

git clone https://github.com/openpandacodes/intent-mcp-server.git
cd intent-mcp-server

2. Install dependencies:

npm install

3. Create a .env file:

touch .env

📚 Documentation

Configuration

You can configure the following options via environment variables:

• NODE_ENV: Set the environment (default is development).
• PORT: Set the server port (default is 3000).
• LOG_LEVEL: Set the log level (default is info).

Usage

Development Mode

npm run dev

Production Mode

npm start

Testing

npm test

Coverage Testing

npm run coverage

API Endpoints

Create an Intent

POST /intents

Get an Intent

GET /intents/:id

Health Check

GET /health

Architecture

The server follows a layered architecture:

• Controller: Handles HTTP requests and responses.
• Service: Responsible for business logic and data operations.
• Storage: Provides data persistence.

Key Components

• IntentController: Handles intent-related requests.
• IntentService: Manages the creation and retrieval of intents.
• IntentStore: Stores intent data.

Project Structure

intent-mcp-server/
├── src/
│   ├── controllers/
│   │   └── IntentController.ts
│   ├── services/
│   │   └── IntentService.ts
│   └── storage/
│       └── IntentStore.ts
├── .env
└── package.json

Intent Structure

interface Intent {
  id: string;
  name: string;
  description?: string;
  status: 'pending' | 'processing' | 'completed' | 'failed';
  metadata?: Record<string, any>;
}

Error Handling

• Provide custom error classes.
• Log errors to track issues.
• Return appropriate HTTP status codes.

Contribution Guidelines

1. Create a feature branch:

git checkout -b feature/new-feature

2. Follow the Conventional Commits specification when committing code.

3. Submit a Pull Request to the main repository.

4. Update relevant documentation and test cases.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.