Skip to content

delphi-blocks/mcpconnect-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MCPConnect Documentation

This repository contains the official documentation for MCPConnect, a powerful, attribute-driven Delphi library for building Model Context Protocol (MCP) servers. MCPConnect lets you expose existing Delphi classes as MCP tools, resources, and prompts with minimal boilerplate, supporting multiple transports (HTTP via WebBroker/Indy and STDIO) and full JSON-RPC 2.0 compliance.

Documentation Build with VitePress

The MCPConnect documentation is built using VitePress, a modern, fast static site generator powered by Vite and Vue.js. Below are the steps to set up the environment, build the documentation, and serve it locally.

Prerequisites

Make sure you have the following installed on your machine:

  • Node.js version 18 or higher.
  • Terminal for accessing VitePress via its command line interface (CLI).

Installation

  1. Clone the Repository:

    git clone https://github.com/delphi-blocks/mcpconnect-docs.git
    cd mcpconnect-docs
  2. Install Dependencies:

    npm install

Running the Documentation Locally

To run the documentation on a local server for development purposes, use the following command:

npm run docs:dev

This will start a local server, and the documentation will be available at http://localhost:5173/. VitePress will automatically reload when changes are made to the documentation files.

Building the Documentation for Production

To generate a production build of the documentation, run the following command:

npm run docs:build

This command will create a static version of the site in the docs/.vitepress/dist directory. The documentation is published at https://mcpconnect.delphiblocks.dev/.

Contributions

We welcome contributions to both the MCPConnect documentation and its underlying build process. If you have suggestions or improvements, feel free to open a pull request or file an issue. Let’s work together to keep the documentation clear and up-to-date!


About

Documentation for MCPConnect: guides, API reference, and integration examples.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors