JSPM

@iflow-mcp/simple-files-vectorstore

0.1.8
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q61912F

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@iflow-mcp/simple-files-vectorstore) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @lishenxydlgzs/simple-files-vectorstore

    A Model Context Protocol (MCP) server that provides semantic search capabilities across files. This server watches specified directories and creates vector embeddings of file contents, enabling semantic search across your documents.

    Installation & Usage

    Add to your MCP settings file:

    {
      "mcpServers": {
        "files-vectorstore": {
          "command": "npx",
          "args": [
            "-y",
            "@lishenxydlgzs/simple-files-vectorstore"
          ],
          "env": {
            "WATCH_DIRECTORIES": "/path/to/your/directories"
          },
          "disabled": false,
          "autoApprove": []
        }
      }
    }

    MCP settings file locations:

    • VSCode Cline Extension: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
    • Claude Desktop App: ~/Library/Application Support/Claude/claude_desktop_config.json

    Configuration

    The server requires configuration through environment variables:

    Required Environment Variables

    You must specify directories to watch using ONE of the following methods:

    • WATCH_DIRECTORIES: Comma-separated list of directories to watch
    • WATCH_CONFIG_FILE: Path to a JSON configuration file with a watchList array

    Example using WATCH_DIRECTORIES:

    {
      "mcpServers": {
        "files-vectorstore": {
          "command": "npx",
          "args": [
            "-y",
            "@lishenxydlgzs/simple-files-vectorstore"
          ],
          "env": {
            "WATCH_DIRECTORIES": "/path/to/dir1,/path/to/dir2"
          },
          "disabled": false,
          "autoApprove": []
        }
      }
    }

    Example using WATCH_CONFIG_FILE:

    {
      "mcpServers": {
        "files-vectorstore": {
          "command": "npx",
          "args": [
            "-y",
            "@lishenxydlgzs/simple-files-vectorstore"
          ],
          "env": {
            "WATCH_CONFIG_FILE": "/path/to/watch-config.json"
          },
          "disabled": false,
          "autoApprove": []
        }
      }
    }

    The watch config file should have the following structure:

    {
      "watchList": [
        "/path/to/dir1",
        "/path/to/dir2",
        "/path/to/specific/file.txt"
      ]
    }

    Optional Environment Variables

    • CHUNK_SIZE: Size of text chunks for processing (default: 1000)
    • CHUNK_OVERLAP: Overlap between chunks (default: 200)
    • IGNORE_FILE: Path to a .gitignore style file to exclude files/directories based on patterns

    Example with all optional parameters:

      {
        "mcpServers": {
          "files-vectorstore": {
            "command": "npx",
            "args": [
              "-y",
              "@lishenxydlgzs/simple-files-vectorstore"
            ],
            "env": {
              "WATCH_DIRECTORIES": "/path/to/dir1,/path/to/dir2",
              "CHUNK_SIZE": "2000",
              "CHUNK_OVERLAP": "500",
              "IGNORE_FILE": "/path/to/.gitignore"
            },
            "disabled": false,
            "autoApprove": []
          }
        }
      }

    MCP Tools

    This server provides the following MCP tools:

    Perform semantic search across indexed files.

    Parameters:

    • query (required): The search query string
    • limit (optional): Maximum number of results to return (default: 5, max: 20)

    Example response:

    [
      {
        "content": "matched text content",
        "source": "/path/to/file",
        "fileType": "markdown",
        "score": 0.85
      }
    ]

    2. get_stats

    Get statistics about indexed files.

    Parameters: None

    Example response:

    {
      "totalDocuments": 42,
      "watchedDirectories": ["/path/to/docs"],
      "processingFiles": []
    }

    Features

    • Real-time file watching and indexing
    • Semantic search using vector embeddings
    • Support for multiple file types
    • Configurable chunk size and overlap
    • Background processing of files
    • Automatic handling of file changes and deletions

    Repository

    GitHub Repository