Merge pull request #3 from promptmesh/feat/docs

setup mkdocs material

Author: SecretiveShell

.github/workflows/mkdocs.yml

@@ -0,0 +1,30 @@
+name: mkdocs deploy
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache 
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

docs/assets/logo-dark-transparent.png

@@ -0,0 +1,41 @@
+# EasyMCP
+
+EasyMCP is a modern Python implementation of the Model Context Protocol (MCP), designed to manage and interact with distributed AI servers, tools, and resources using a consistent and extensible API.
+
+---
+
+## Features
+
+- 🌐 Multi-server orchestration via `ClientManager`
+- 🧠 Built-in support for tools, resources, and prompts
+- 🔄 Automatic cache invalidation via push notifications
+- 🧪 Async-native, with support for subprocesses, Docker, SSE transports
+- 🔌 Easy integration with search engines like Meilisearch
+
+---
+
+## Installation
+
+```bash
+uv add easymcp
+```
+
+---
+
+## Quickstart
+
+```python
+from easymcp.client.ClientManager import ClientManager
+from easymcp.client.transports.stdio import StdioServerParameters
+
+mgr = ClientManager()
+
+servers = {
+    "timeserver": StdioServerParameters(command="uvx", args=["mcp-timeserver"])
+}
+
+await mgr.init(servers)
+tools = await mgr.list_tools()
+```
+
+Check out [Usage](usage.md) to learn more.

docs/index.md

@@ -0,0 +1,43 @@
+# Usage
+
+## Managing Servers
+
+Use `ClientManager` to start and stop multiple MCP servers.
+
+```python
+from easymcp.client.ClientManager import ClientManager
+from easymcp.client.transports.stdio import StdioServerParameters
+
+mgr = ClientManager()
+
+await mgr.init({
+    "timeserver": StdioServerParameters(command="uvx", args=["mcp-timeserver"])
+})
+```
+
+---
+
+## Listing & Calling Tools
+
+```python
+tools = await mgr.list_tools()
+result = await mgr.call_tool("timeserver.get-current-time", {})
+```
+
+---
+
+## Reading Resources
+
+```python
+resources = await mgr.list_resources()
+data = await mgr.read_resource("mcp-timeserver+datetime://UTC/now")
+```
+
+---
+
+## Using Prompts
+
+```python
+prompts = await mgr.list_prompts()
+response = await mgr.read_prompt("wa", {"query": "pi"})
+```

docs/usage.md

@@ -0,0 +1,51 @@
+site_name: EasyMCP
+site_url: https://easymcp.promptmesh.io
+repo_url: https://github.com/promptmesh/easymcp
+repo_name: promptmesh/easymcp
+copyright: Copyright © 2025 Promptmesh
+
+theme:
+  name: material
+  palette:
+    - scheme: slate
+      primary: black
+      accent: blue
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - toc.integrate
+    - content.code.copy
+    - content.code.annotate
+    - content.action.edit
+    - content.tabs.link
+  icon:
+    logo: material/lambda
+    repo: fontawesome/brands/github
+  font:
+    text: Inter
+    code: JetBrains Mono
+
+nav:
+  - Home: index.md
+  - Usage: usage.md
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - toc:
+      permalink: true
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+  - pymdownx.details
+  - pymdownx.emoji
+  - pymdownx.keys
+  - pymdownx.tabbed:
+      alternate_style: true
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/promptmesh
+  generator: false