Aintent Framework

🚀 Target MCP Server

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

🚀 Quick Start

The project implements an intent processing architecture that converts natural language inputs into structured objects and generates executable workflows. It emphasizes maintainability, type safety, and scalability, and provides a clear API for intent management.

✨ Features

• 🎯 Intent Processing: Create, retrieve, and process intents through a well-defined API.
• 🔍 Natural Language Understanding: Parse and comprehend raw user intents.
• 🧩 Intent Decomposition: Transform intents into structured objects containing goals and constraints.
• 💾 Flexible Storage: A pluggable storage system with a built-in in-memory implementation.
• 📝 Type Safety: Fully implemented in TypeScript with documentation.
• 🛠️ Powerful API: Provides functions to create, read, update, and delete intents.
• 🔄 Scalable Design: Easily add new functional modules.

📦 Installation

Prerequisites

To use this project, ensure you have the following tools installed:

• Node.js (version 14 or higher recommended)
• npm (Node Package Manager)

Steps

Clone the repository from GitHub and install the dependencies:

git clone https://github.com/yourusername/intent-mcp.git
cd intent-mcp
npm install

📚 Documentation

Configuration

You can configure the server's behavior through the following environment variables:

• NODE_ENV: Sets the runtime environment (development or production), default is development.
• PORT: Specifies the port the server listens on, default is 3000.
• DB_URI: Database connection URI, default is mongodb://localhost:27017/intents.

Usage

Development Mode

npm run dev

Production Mode

npm start

Testing

npm test

API Endpoints

Create an Intent

Method: POST
Path: /api/intents
Request Body Format: JSON

Example Request:

{
  "intentName": "order_food",
  "description": "Process food orders"
}

Get All Intents

Method: GET
Path: /api/intents

Get an Intent by ID

Method: GET
Path: /api/intents/:id

Update an Intent

Method: PUT
Path: /api/intents/:id
Request Body Format: JSON

Example Request:

{
  "intentName": "order_food_updated",
  "description": "Update food order processing"
}

Delete an Intent

Method: DELETE
Path: /api/intents/:id

Architecture

The project follows a clean architecture pattern, divided into the following layers:

• Controllers: Handle HTTP requests and responses.
• Services: Responsible for business logic and data operations.
• Storage: Provides data persistence functionality.
• Models: Define data structures and validation rules.

Project Structure

intent-mcp/
├── controllers/          # Controllers
├── services/            # Service layer
├── storage/             # Storage implementation
├── models/              # Data models
├── config/              # Configuration files
└── routes/              # Route definitions

Intent Structure

Intents are defined by the following TypeScript interface:

interface Intent {
  id: string;
  intentName: string;
  description: string;
  createdAt: Date;
  updatedAt: Date;
}

Error Handling

The system provides a comprehensive error handling mechanism, including:

• Custom error classes.
• HTTP status codes and response bodies.
• Logging and tracking.

Contribution Guidelines

Contributions are welcome! Please follow these steps to participate in the project:

1. Fork the repository to your account.
2. Create a feature branch.
3. Commit your changes and create a Pull Request.
4. Update the documentation if necessary.

Please ensure your commit messages follow the Conventional Commits specification, and describe the changes in the Pull Request.

📄 License

This project is under the MIT License. See the LICENSE file for details.