Skip to content

Deployment: Dockerfile and Smithery config #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
FROM python:3.11-slim

WORKDIR /app

# Install system dependencies
RUN apt-get update && apt-get install -y --no-install-recommends \
build-essential \
&& rm -rf /var/lib/apt/lists/*

# Set environment variables
ENV PYTHONUNBUFFERED=1 \
PYTHONDONTWRITEBYTECODE=1

# Copy MCP server code
COPY fast-markdown-mcp/ /app/

# Install dependencies directly without using a virtual environment
RUN pip install --no-cache-dir -e .

# Create necessary directories
RUN mkdir -p /app/storage/markdown
Comment on lines +19 to +22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Consider Consolidating RUN Commands
Currently, there are separate RUN instructions for installing dependencies and creating directories. Consolidating these steps (when it does not negatively affect layer caching) could help reduce the final image size by cutting down on the number of layers. Review whether merging these commands fits your build strategy.

🧰 Tools
🪛 Hadolint (2.12.0)

[info] 22-22: Multiple consecutive RUN instructions. Consider consolidation.

(DL3059)


# Expose the port that the MCP server might use for communication
EXPOSE 8765

# Command to run the MCP server
CMD ["python", "-m", "fast_markdown_mcp.server", "/app/storage/markdown"]
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ DevDocs brings documentation to you. Point it at any tech documentation URL, and

DevDocs is designed to be easy to use with Docker, requiring minimal setup for new users.

### Installing via Smithery

To install DevDocs for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@cyberagiinc/DevDocs):

```bash
npx -y @smithery/cli install @cyberagiinc/DevDocs --client claude
```

### Prerequisites

- [Docker](https://docs.docker.com/get-docker/) installed on your system
Expand Down Expand Up @@ -318,4 +326,4 @@ Final Output Construction: The final answer should be organized, directly addres

<p align="center">
<sub>Make Software Development Better Again <a href="https://github.com/cyberagi/devdocs">Contribute to DevDocs</a></sub>
</p>
</p>
16 changes: 16 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml

startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
properties: {}
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({
command: 'python',
args: ['-m', 'fast_markdown_mcp.server', '/app/storage/markdown']
})
exampleConfig: {}