Skip to main content

A comprehensive MCP server for AI knowledge management with Elasticsearch, file operations, and version control

Project description

Agent Knowledge MCP ๐Ÿ”

The complete knowledge management solution
Powerful Model Context Protocol server for Elasticsearch integration with comprehensive file management and version control.

Python Version MCP Compatible License: MIT Buy Me Coffee GitHub Sponsors

๐Ÿš€ What is Agent Knowledge MCP?

The most comprehensive MCP server that transforms your AI assistant into a powerful knowledge management system. The key advantage? It combines everything you needโ€”Elasticsearch search, file operations, document validation, and version control in one unified solution.

๐Ÿ”‘ Complete Knowledge Management:

  • โœ… Elasticsearch Integration: Full-featured search, indexing, and document management
  • โœ… File System Control: Comprehensive file operations with cross-platform support
  • โœ… Document Validation: Schema-enforced document structure with strict validation modes
  • โœ… Configuration Management: Complete config control with validation and reloading
  • โœ… Version Control: Git and SVN support with intelligent file tracking
  • โœ… Security First: Sandboxed operations with configurable restrictions
  • โœ… Production Ready: Battle-tested with comprehensive error handling

โœจ Key Benefits:

  • ๐ŸŽฏ 34 Powerful Tools: Everything from search to version control and config management with strict schema validation
  • ๐Ÿ”„ Universal AI Support: Works with Claude, ChatGPT, Cursor, and any MCP-compatible AI
  • ๐Ÿ“Š Smart Document Management: Auto-validation, templates, and structured data with configurable strict schema control
  • ๐Ÿ›ก๏ธ Enterprise Security: Path validation, access controls, and audit trails
  • โšก Zero Dependencies: Optional Elasticsearch - works standalone for file operations

๐ŸŒ AI Assistant Support

Works with any MCP-compatible AI assistant:

  • โœ… Claude Desktop
  • โœ… ChatGPT Plus (with MCP support)
  • โœ… Cursor IDE
  • โœ… Windsurf
  • โœ… VS Code (with MCP extension)
  • โœ… Any MCP client

Perfect for developers who want to automate knowledge management and teams who need structured document workflows!

๐ŸŽฌ What You Can Do

Real workflows you can try today:

๐Ÿ“š Knowledge Management

  • "Search all documents for information about API authentication and create a comprehensive guide"
  • "Index this technical document with proper categorization and tags"
  • "Find all documents related to deployment and generate a deployment checklist"
  • "Create a new document template for API documentation with required fields"

๐Ÿ“ File Operations & Organization

  • "Organize all markdown files by category and move them to appropriate directories"
  • "Read all configuration files and create a settings summary document"
  • "Find duplicate files in the project and list them for cleanup"
  • "Create a project structure document listing all important files"

๐Ÿ”„ Version Control & History

  • "Setup Git repository for this knowledge base and commit all current documents"
  • "Check what changes were made to the user manual in the last version"
  • "Commit these updated API docs with a descriptive message"
  • "Show me the previous version of this configuration file"

๐Ÿค– Development & Documentation

  • "Index all code documentation and make it searchable"
  • "Create a changelog from Git commit history"
  • "Validate all documents follow our schema requirements"
  • "Generate project documentation from README files"

๐Ÿ” Configuration & Schema Management

  • "Update configuration to enable strict schema validation for all documents"
  • "Show me the current configuration settings and validation rules"
  • "Validate this configuration before applying it to prevent errors"
  • "Disable extra fields in documents to enforce strict schema compliance"

๐Ÿ” Advanced Search & Analysis

  • "Search across all documents and files for security-related information"
  • "Find all TODO comments in code files and create a task list"
  • "Analyze document metadata and generate a content report"
  • "Search for outdated information and flag it for review"

โ˜• Support This Project

If you find this MCP server useful, consider supporting its development:

Buy Me A Coffee GitHub Sponsors PayPal Ko-fi

๐Ÿ’ Why Support?

  • ๐Ÿš€ Faster development of new features and improvements
  • ๐Ÿ› Priority bug fixes and technical support
  • ๐Ÿ“š Better documentation and comprehensive tutorials
  • ๐ŸŽฏ Community-requested features implementation
  • ๐Ÿ›ก๏ธ Enhanced security and stability updates
  • ๐ŸŒŸ Long-term project sustainability

๐ŸŽ Sponsor Benefits

Tier Amount Benefits
โ˜• Coffee $5 Thank you mention in README + priority issue responses
๐Ÿš€ Supporter $15 Feature request consideration + early access to updates
๐Ÿ’Ž Sponsor $30 Logo in README + special recognition in releases
๐ŸŒŸ Gold Sponsor $50+ Custom benefits discussion + direct communication channel

Every contribution helps maintain and improve this open-source project! ๐Ÿ™

โšก Quick Start

1. Installation

# Install with uvx (recommended)
uvx agent-knowledge-mcp

2. Configuration

# Copy and edit configuration
cp src/config.json.example src/config.json
nano src/config.json

3. Connect to Your AI Assistant

Claude Desktop - Add to claude_desktop_config.json:

{
  "mcpServers": {
    "agent-knowledge": {
      "command": "uvx",
      "args": ["agent-knowledge-mcp"]
    }
  }
}

VS Code - Quick install buttons:

Install in VS Code Install in VS Code Insiders

Other AI Assistants - Add similar configuration:

{
  "mcp.servers": {
    "agent-knowledge": {
      "command": "uvx",
      "args": ["agent-knowledge-mcp"]
    }
  }
}

Note: The server has built-in update mechanisms accessible through admin tools.

๏ธ Capabilities

Agent Knowledge MCP provides 34 powerful tools across 4 categories:

๐Ÿ” Elasticsearch Operations (9 tools)

  • Smart Search - Multi-field queries with boosting and relevance scoring
  • Document Management - Index, retrieve, update, delete with validation
  • Index Administration - Create, configure, manage Elasticsearch indices
  • Schema Validation - Enforce document structure and data types
  • Template Generation - Auto-create document templates with required fields

๐Ÿ“ File System Management (11 tools)

  • File Operations - Read, write, append, delete, move, copy with safety checks
  • Directory Management - Create, list, navigate directory structures
  • Path Intelligence - Relative/absolute path conversion and validation
  • File Discovery - Search files by name, content, or metadata
  • Cross-Platform - Windows, macOS, Linux compatibility

๐ŸŽ›๏ธ System Administration (11 tools)

  • Configuration Management - Complete config viewing, modification, and validation with strict schema controls
  • Security Controls - Access restrictions and path validation
  • Health Monitoring - System status and Elasticsearch connectivity
  • Auto-Setup - Intelligent Elasticsearch configuration
  • Environment Management - Directory permissions and structure
  • Strict Schema Control - Configurable document validation to prevent unauthorized field additions
  • Server Management - Check status, upgrade MCP server

๐Ÿ”„ Version Control (3 tools)

  • Repository Setup - Git/SVN initialization with best practices
  • File Tracking - Intelligent commit with change detection
  • History Access - Retrieve any previous version of files
  • Multi-VCS - Support for both Git and SVN workflows

๐Ÿ’ฌ Example Prompts to Try

Once everything is set up, try asking your AI:

Knowledge Discovery:

"Search all indexed documents for information about user authentication and summarize the key points"

Document Creation:

"Create a new API documentation template and index it with proper categorization"

File Management:

"Find all configuration files in the project and create a backup in the configs directory"

Version Control:

"Setup version control for this knowledge base and commit all current documents with proper organization"

Content Analysis:

"Analyze all markdown files for outdated information and create a list of files that need updates"

Project Documentation:

"Read all README files in subdirectories and create a comprehensive project overview document"

graph TD
    A[AI Assistant] --> B[MCP Server]
    B --> C[Elasticsearch Client]
    B --> D[File System Handler]
    B --> E[Version Control Handler]
    B --> F[Document Validator]
    
    C --> G[Elasticsearch Cluster]
    D --> H[Local File System]
    E --> I[Git/SVN Repository]
    F --> J[Schema Validation]

Modern, Modular Design:

  1. MCP Protocol - Standard communication with AI assistants
  2. Elasticsearch Integration - Full-featured search and indexing
  3. File System Safety - Sandboxed operations with validation
  4. Version Control - Git/SVN support with intelligent workflows
  5. Document Validation - Schema enforcement and template generation

๐Ÿ”’ Security & Privacy

Enterprise-grade security:

  • โœ… Sandboxed Operations - All file operations restricted to configured directories
  • โœ… Path Validation - Prevent directory traversal and unauthorized access
  • โœ… Access Controls - Configurable permissions and restrictions
  • โœ… Audit Trails - Full logging of operations and changes
  • โœ… No Cloud Dependencies - Everything runs locally

Configuration Example:

{
  "security": {
    "allowed_base_directory": "/your/safe/directory",
    "restrict_file_operations": true,
    "log_all_operations": true
  }
}

๐Ÿ›ก๏ธ Strict Schema Validation

NEW: Configurable strict schema validation to prevent unwanted data corruption:

{
  "document_validation": {
    "strict_schema_validation": true,
    "allow_extra_fields": false,
    "required_fields_only": false,
    "auto_correct_paths": true
  }
}

Features:

  • โœ… Strict Mode - Reject documents with extra fields beyond the schema
  • โœ… Flexible Control - Enable/disable validation per use case
  • โœ… Schema Compliance - Ensure all documents follow defined structure
  • โœ… Clear Error Messages - Detailed validation feedback with examples
  • โœ… Backward Compatibility - Works with existing documents

Benefits:

  • ๐Ÿ›ก๏ธ Data Integrity - Prevent agents from adding arbitrary fields
  • ๐Ÿ“Š Consistent Structure - Maintain clean, predictable document schemas
  • ๐Ÿ”ง Easy Management - Toggle validation modes through configuration
  • ๐Ÿš€ Production Ready - Ideal for enterprise knowledge management

Example validation error:

โŒ Document validation failed!
Extra fields not allowed in strict mode: custom_field, extra_data
Allowed fields: id, title, summary, file_path, priority, tags, source_type

๐Ÿ“Š Tool Reference

Category Count Tools
Elasticsearch 9 search, index_document, create_index, get_document, delete_document, list_indices, delete_index, validate_document_schema, create_document_template
File System 11 read_file, write_file, append_file, delete_file, move_file, copy_file, list_directory, create_directory, delete_directory, file_info, search_files
Administration 11 get_config, update_config, validate_config, get_allowed_directory, set_allowed_directory, reload_config, setup_elasticsearch, elasticsearch_status, server_status, server_upgrade, server_uninstall
Version Control 3 setup_version_control, commit_file, get_previous_file_version

Total: 34 tools for comprehensive knowledge management!

Quality Assurance:

  • โœ… Unit Tests - All core functionality tested
  • โœ… Integration Tests - End-to-end workflow validation
  • โœ… Error Handling - Comprehensive error scenarios covered
  • โœ… Cross-Platform - Tested on Windows, macOS, Linux

๐Ÿค Contributing

Love to have your help making Agent Knowledge MCP even better!

Quick Development Setup

git clone https://github.com/yourusername/AgentKnowledgeMCP.git
cd AgentKnowledgeMCP

# Install dependencies
pip install -r requirements.txt

# Run tests
python3 test_file_paths.py

# Start development server
python3 src/server.py

Ways to Contribute

  • ๐Ÿ› Report bugs via GitHub Issues
  • ๐Ÿ’ก Suggest features for new tools or capabilities
  • ๐Ÿ”ง Add new tools or improve existing ones
  • ๐Ÿ“– Improve documentation and examples
  • ๐Ÿงช Test with different AI assistants and share results

Development Guidelines

  • Modular Design - Each tool category in separate handlers
  • Comprehensive Testing - Test all new functionality
  • Security First - Validate all inputs and file operations
  • Cross-Platform - Ensure compatibility across operating systems

๐Ÿ“ License

MIT License - see LICENSE for details.

๐Ÿ’– Contributing & Support

๐Ÿค How to Contribute

  • ๐Ÿ› Report bugs via GitHub Issues
  • ๐Ÿ’ก Suggest features for new tools or capabilities
  • ๐Ÿ”ง Submit pull requests for improvements
  • ๐Ÿ“– Improve documentation and examples
  • ๐Ÿงช Test with different AI assistants and share feedback

โ˜• Financial Support

If this project saves you time or helps your workflow:

Buy Me A Coffee GitHub Sponsors

๐ŸŒŸ Special Thanks

  • All our amazing contributors and supporters
  • The Model Context Protocol community
  • Elasticsearch team for their excellent search engine
  • Python ecosystem for powerful development tools

Ready to supercharge your AI assistant with comprehensive knowledge management? Get started today! ๐Ÿš€

Transform your AI into a powerful knowledge management system with Elasticsearch search, intelligent file operations, and version control - all in one unified MCP server.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_knowledge_mcp-1.0.21.tar.gz (58.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_knowledge_mcp-1.0.21-py3-none-any.whl (46.7 kB view details)

Uploaded Python 3

File details

Details for the file agent_knowledge_mcp-1.0.21.tar.gz.

File metadata

  • Download URL: agent_knowledge_mcp-1.0.21.tar.gz
  • Upload date:
  • Size: 58.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for agent_knowledge_mcp-1.0.21.tar.gz
Algorithm Hash digest
SHA256 7249c7eb3f906549156592b7d9a62f36e33ef00852c5edc62ad7599e8b382f7e
MD5 3c0dfbd9155d38ff94ce7773a867dd63
BLAKE2b-256 b4c280677e201a8707daa303412a63165c1e835e7e3f4f850466a9eccd6ab358

See more details on using hashes here.

File details

Details for the file agent_knowledge_mcp-1.0.21-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_knowledge_mcp-1.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 cc87a9d1b2d4ed743a22ae6b8956067b79b28dc0f5543b4ca59ac803982e2c70
MD5 e1c4bfa8844ae61180010e8d8e034fc8
BLAKE2b-256 7b23e2093d45dccb05aaee290c869d7181cc70af363618e10d46fbf7673f112c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page