feat: Init MCP Server

Author: chyroc

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.6.7
+    hooks:
+      # Run the linter.
+      - id: ruff
+        types_or: [ python, pyi ]
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [ python, pyi ]

.python-version

@@ -0,0 +1 @@
+3.11

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+## Setting up the environment
+
+create a virtual environment:
+
+```shell
+python -m venv ./.venv
+```
+
+active the virtual environment:
+
+```shell
+source ./.venv/bin/activate
+```
+
+We use [uv](https://docs.astral.sh/uv/) to manage dependencies, you can install it by:
+
+```shell
+python -m pip install uv 
+```
+
+And then install dependencies:
+
+```shell
+uv sync
+```
+
+## Pre Commit
+
+```shell
+pre-commit install
+```
+
+## Dev MCP Server
+
+start mcp dev server:
+
+
+```shell
+export COZE_API_TOKEN=your_coze_token
+mcp dev src/coze_mcp_server/server.py
+```
+
+## Prod MCP Server
+
+```shell
+uvx coze-mcp-server --coze-api-token=your_coze_token
+```

Dockerfile

@@ -0,0 +1,36 @@
+# Use a Python image with uv pre-installed
+FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS uv
+
+# Install the project into `/app`
+WORKDIR /app
+
+# Enable bytecode compilation
+ENV UV_COMPILE_BYTECODE=1
+
+# Copy from the cache instead of linking since it's a mounted volume
+ENV UV_LINK_MODE=copy
+
+# Install the project's dependencies using the lockfile and settings
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project --no-dev --no-editable
+
+# Then, add the rest of the project source code and install it
+# Installing separately from its dependencies allows optimal layer caching
+ADD . /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-dev --no-editable
+
+FROM python:3.12-slim-bookworm
+
+WORKDIR /app
+ 
+COPY --from=uv /root/.local /root/.local
+COPY --from=uv --chown=app:app /app/.venv /app/.venv
+
+# Place executables in the environment at the front of the path
+ENV PATH="/app/.venv/bin:$PATH"
+
+# when running the container, add --db-path and a bind mount to the host's db file
+ENTRYPOINT ["coze-mcp-server"]

README.md

@@ -1,2 +1,118 @@
-# coze-mcp-server
-mcp server for coze
+# COZE MCP Server
+
+A Model Context Protocol server that provides coze resource and tool.
+
+### Available Tools
+
+- `list_workspaces` - Get workspaces list
+- `list_bots` - Get bots list
+- `create_bot` - Create bot
+
+## Installation
+
+### Using uv (recommended)
+
+When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will
+use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *coze-mcp-server*.
+
+### Using PIP
+
+Alternatively you can install `coze-mcp-server` via pip:
+
+```bash
+pip install coze-mcp-server
+```
+
+After installation, you can run it as a script using:
+
+```bash
+python -m coze_mcp_server
+```
+
+## Configuration
+
+### Configure for Claude.app
+
+Add to your Claude settings:
+
+<details>
+<summary>Using uvx</summary>
+
+```json
+"mcpServers": {
+  "coze-mcp-server": {
+    "command": "uvx",
+    "args": ["coze-mcp-server"]
+  }
+}
+```
+</details>
+
+<details>
+<summary>Using docker</summary>
+
+```json
+"mcpServers": {
+  "coze-mcp-server": {
+    "command": "docker",
+    "args": ["run", "-i", "--rm", "coze-mcp-server"]
+  }
+}
+```
+</details>
+
+<details>
+<summary>Using pip installation</summary>
+
+```json
+"mcpServers": {
+  "coze-mcp-server": {
+    "command": "python",
+    "args": ["-m", "coze_mcp_server"]
+  }
+}
+```
+</details>
+
+### Configure for Zed
+
+Add to your Zed settings.json:
+
+<details>
+<summary>Using uvx</summary>
+
+```json
+"context_servers": [
+  "coze-mcp-server": {
+    "command": "uvx",
+    "args": ["coze-mcp-server"]
+  }
+],
+```
+</details>
+
+<details>
+<summary>Using pip installation</summary>
+
+```json
+"context_servers": {
+  "coze-mcp-server": {
+    "command": "python",
+    "args": ["-m", "coze_mcp_server"]
+  }
+},
+```
+</details>
+
+## Build
+
+Docker build:
+
+```bash
+cd src/coze_mcp_server
+docker build -t coze_mcp_server .
+```
+
+## License
+
+MIT License.