MCP Document Server

🚀 MCP Document Server

A simple server implementing the Model Context Protocol (MCP) for document search and retrieval.

✨ Features

• Store and retrieve documents using MCP.
• Provide semantic search functionality.
• Be compatible with Cursor and other MCP clients.
• Adopt a pluggable document service architecture:
  • Support local JSON document storage.
  • Integrate Confluence workspace document search.
• Support HTML format.

📦 Installation

1. Install dependencies:

npm install

2. Build TypeScript code:

npm run build

3. Start the server:

npm run stdio

💻 Usage Examples

Usage with Cursor

This server is designed to work with Cursor. You can use the search tool with the keyword parameter to search for documents.

Example:

search({
  keyword: "data"
})

Create a Document

You can create a new document directly from Cursor:

create_document({
  title: "New Confluence Page",
  content: "This is a page created in Confluence",
  serviceId: "confluence"
})

📚 Documentation

Document Services

The architecture is based on a pluggable document service design. Each service implements a common interface for searching and retrieving documents.

Local Storage Service

The local storage service stores documents in the local file system:

• Documents are stored in the data/documents/ directory (automatically created).
• Metadata is stored in the data/documents.json file (automatically created).
• Support content in Markdown and HTML formats.

Confluence Service

The Confluence service uses the Confluence REST API and CQL (Confluence Query Language) to search workspace documents. To enable this feature, set the following environment variables:

# Confluence configuration
export CONFLUENCE_BASE_URL="https://your-domain.atlassian.net/wiki"
export CONFLUENCE_USERNAME="your-email@example.com"
export CONFLUENCE_API_TOKEN="your-api-token"
export CONFLUENCE_SPACE="your-space-key"

You can set these variables before starting the server:

CONFLUENCE_BASE_URL="https://your-domain.atlassian.net/wiki" \
CONFLUENCE_USERNAME="your-email@example.com" \
CONFLUENCE_API_TOKEN="your-api-token" \
CONFLUENCE_SPACE="your-space-key" \
npm run stdio

Authentication Details

The service uses Basic authentication with your email and API token. Credentials are sent in Base64-encoded format to the authorization header:

Authorization: Basic <base64-encoded-email:token>

Manage Documents

The local storage service automatically creates the data/documents directory and the data/documents.json file on first use. These files are not in the repository and are generated on demand.

Extend the Server

Add a New Document Service

The MCP server is designed to be extensible. You can add a new service by implementing the DocumentService interface:

interface DocumentService {
  id: string;
  getByKeywords: (keywords: string[]) => Promise<Document[]>;
  createDocument?: (title: string, content: string) => Promise<Document>;
}

To add a new service:

1. Create a new directory under the src/services/ directory.
2. Implement the DocumentService interface.
3. Register your service in src/services/index.ts.

Some potential directions for implementing document services include:

• Google Drive: Connect to the Google Drive API for document storage and retrieval.
• OneDrive/SharePoint: Integrate Microsoft's document services.
• Notion: Add support for Notion workspaces.
• GitHub Wiki: Connect to the GitHub Wiki for document management.
• Custom Database: Store documents in a SQL or NoSQL database.