Merge pull request #1174 from dhsifss/feat/mcp

feat: add doc and rename

Author: safe1ine

slmcp/.python-version mcp_server/.python-versionslmcp/.python-version renamed to mcp_server/.python-version

@@ -0,0 +1,52 @@
+## mcp_server - A SafeLine WAF mcp server
+
+- Easy to use
+    - one command to run mcp_server
+- Easy to develop
+    - add yoor own tools to `tools` dirctory without modify other files
+
+### quick start
+
+```shell
+docker compose -f docker-compose.yaml up -d
+```
+
+### custom your own tool
+
+#### Hello Tool Example
+
+This tool used to say hello to someone
+
+1. create file `tools/hello.py`
+
+```python
+from pydantic import BaseModel, Field
+from tools import register_tool, Tool
+
+# Hello describe function paramters
+class Hello(BaseModel):
+    name: str = Field(description="username to say hello")
+
+# hello is tool logic
+async def hello(arguments: dict) -> str:
+    """
+    Say hello to someone
+    """
+    return f"Hello {arguments['name']}"
+
+# register tool to global variable
+register_tool(
+    Tool(
+        name="hello",
+        description="say hello to someone",
+        inputSchema=Hello.model_json_schema()
+    ),
+    hello
+)
+```
+
+2. import this tool in `tools/__init__.py`
+
+```python
+from . import hello
+```

slmcp/Dockerfile mcp_server/Dockerfileslmcp/Dockerfile renamed to mcp_server/Dockerfile

@@ -9,6 +9,8 @@ class Config:
 
     def __init__(self):
         self.SAFELINE_ADDRESS = os.getenv("SAFELINE_ADDRESS")
+        if self.SAFELINE_ADDRESS:
+            self.SAFELINE_ADDRESS = self.SAFELINE_ADDRESS.removesuffix("/")
         self.SAFELINE_API_TOKEN = os.getenv("SAFELINE_API_TOKEN")
         self.SECRET = os.getenv("SAFELINE_SECRET")
         env_listen_port = os.getenv("LISTEN_PORT")

mcp_server/README.md

@@ -0,0 +1,12 @@
+services:
+  mcp_server:
+    image: chaitin/mcp_server:0.1
+    container_name: mcp_server
+    ports:
+      - "5678:5678"
+    environment:
+      - SAFELINE_SECRET=your_secret_key # optional, if you want to use secret key to authenticate
+      - SAFELINE_ADDRESS=https://your_safeline_ip:9443 # required, your SafeLine WAF address
+      - SAFELINE_API_TOKEN=your_safeline_api_token # required, your SafeLine WAF api token  
+      - LISTEN_PORT=5678 # optional, default is 5678
+      - LISTEN_ADDRESS=0.0.0.0 # optional, default is 0.0.0.0 

slmcp/__init__.py mcp_server/__init__.pyslmcp/__init__.py renamed to mcp_server/__init__.py

@@ -1,7 +1,7 @@
 [project]
-name = "slmcp"
+name = "mcp_server"
 version = "0.1.0"
-description = "Add your description here"
+description = "SafeLine WAF mcp server"
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [

slmcp/__main__.py mcp_server/__main__.pyslmcp/__main__.py renamed to mcp_server/__main__.py

@@ -33,7 +33,7 @@ idna==3.10
 markdown-it-py==3.0.0
     # via rich
 mcp==1.6.0
-    # via slmcp (pyproject.toml)
+    # via mcp_server (pyproject.toml)
 mdurl==0.1.2
     # via markdown-it-py
 pydantic==2.11.1