Typescript MCP Server with Obsidian Integration

A command-line interface for interacting with your Obsidian vault.

Prerequisites

- Node.js 14.x or later
- npm or yarn
- An Obsidian vault

Setup

1. Clone the repository
2. Install dependencies:

   npm install

   

3. Create a .env file in the project root with your Obsidian vault path:

   OBSIDIAN_VAULT_PATH=/path/to/your/obsidian/vault

   

Development

Client Application

To start the backend:

npm run dev

To start the React frontend:

1. Navigate to the client directory:

   cd client

   

2. Install dependencies (if not already installed):

   npm install

   

3. Start the development server:

   npm run dev

   

The application will be available at http://localhost:5173 by default.

Available Scripts

This project includes several npm scripts to help with development and testing:

Start the Server Application

npm start

Starts the application using ts-node. The server will be available at http://localhost:3000 by default (or the port specified in your environment variables).

Development Mode with Auto-Reload

npm run dev

Starts the application in development mode using nodemon, which automatically restarts the server when you make changes to any TypeScript file in the src directory.

Build the Project

npm run build

Compiles TypeScript files to JavaScript in the dist directory.

Run Tests

npm test

Runs the test suite (currently no tests are configured).

Run CLI Tool

```bash