intent-mcp-server
The Intent MCP Server is a Model Context Protocol server designed to convert natural language intents into structured formats through an extensible and reliable API. It offers features like intent processing, natural language understanding, and flexible storage, all structured with a clean architecture for maintainability.
Intent MCP Server
A Model Context Protocol (MCP) server that processes natural language intents into structured, actionable formats. This server provides a robust API for managing and processing intents with a focus on extensibility and reliability.
Overview
This project implements an intent processing architecture that transforms natural language inputs into structured objects and generates executable workflows. It focuses on maintainability, type safety, and extensibility while providing a clean API for intent management.
Features
- ๐ฏ Intent Processing: Create, retrieve, and process intents through a well-defined API
- ๐ Natural Language Understanding: Parse and understand raw user intentions
- ๐งฉ Intent Decomposition: Transform intentions into structured objects with goals and constraints
- ๐พ Flexible Storage: Pluggable storage system with built-in in-memory implementation
- ๐ Type Safety: Full TypeScript implementation with comprehensive type definitions
- ๐ก๏ธ Error Handling: Robust error handling and logging system
- ๐งช Testing: Comprehensive test suite with Jest
- ๐ API Documentation: Clear API documentation and examples
Prerequisites
- Node.js (v18 or higher)
- npm or yarn
Installation
- Clone the repository:
git clone https://github.com/openpandacodes/intent-mcp-server.git
cd intent-mcp-server
- Install dependencies:
npm install
- Create a
.env
file in the root directory:
cp .env.example .env
- Update the
.env
file with your configuration settings.
Configuration
The server can be configured using environment variables:
NODE_ENV
: Environment (development, production, test)PORT
: Server port (default: 3000)LOG_LEVEL
: Logging level (debug, info, warn, error)
Usage
Development
Start the development server with hot reloading:
npm run dev
Production
Build and start the production server:
npm run build
npm start
Testing
Run tests:
npm test
Run tests with coverage:
npm run test:coverage
API Endpoints
Intent Management
-
POST /api/intent
: Create a new intentcurl -X POST http://localhost:3000/api/intent \ -H "Content-Type: application/json" \ -d '{"rawIntent": "Your natural language intent here"}'
-
GET /api/intent/:id
: Get an intent by IDcurl -X GET http://localhost:3000/api/intent/YOUR_INTENT_ID
Additional endpoints are documented in the API specification.
Health Check
GET /health
: Check server health status
Architecture
The server follows a clean architecture pattern with distinct layers:
- Controllers: Handle HTTP requests and responses
- Services: Implement core business logic and intent processing
- Storage: Manage data persistence with pluggable implementations
- Models: Define data structures and types
Key Components
IntentController
: Handles intent-related HTTP endpointsIntentService
: Core service for intent processingStorageInterface
: Abstract storage layerInMemoryStorage
: Reference implementation of storage interface
Project Structure
intent-mcp-server/
โโโ src/
โ โโโ controllers/ # HTTP request handlers
โ โโโ services/ # Business logic implementation
โ โ โโโ __tests__/ # Service tests
โ โโโ storage/ # Storage implementations
โ โโโ models/ # Type definitions
โ โโโ utils/ # Utility functions
โโโ tests/ # Test suites
โโโ config/ # Configuration files
Intent Structure
The system structures intentions into formal objects:
interface Intent {
id: string;
rawIntent: string;
processed: {
goals: Goal[];
constraints: Constraint[];
metadata: Record<string, unknown>;
};
status: "pending" | "processing" | "completed" | "failed";
createdAt: Date;
updatedAt: Date;
}
Error Handling
The server implements comprehensive error handling:
- Custom error classes for different types of errors
- Proper HTTP status codes and error responses
- Structured logging for debugging and monitoring
- Validation using TypeScript types
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'feat: Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Create a Pull Request
Please ensure your code:
- Follows the existing style and conventions
- Includes appropriate tests
- Updates documentation as needed
- Uses conventional commit messages
License
MIT License - see LICENSE file for details