Metadata-Version: 2.3
Name: gg-mcp-demo-server
Version: 0.1.0
Summary: A minimal MCP server demo: one tool, one resource, and call-logging middleware.
Keywords: mcp,model-context-protocol,llm,demo,middleware
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: mcp[cli]>=2.3.0
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# gg-mcp-demo

一个最小可用的 [MCP](https://modelcontextprotocol.io)（Model Context Protocol）服务器示例，用来演示三件事：

- 注册一个 **tool**（`add`）和一个 **resource**（`greeting://{name}`）；
- 用 **middleware** 把每一次入站请求/通知（方法、参数、耗时、结果）写进调用日志；
- 默认走 **stdio** 传输，可用环境变量切换成 `sse` / `streamable-http`。

## 安装

```bash
pip install gg-mcp-demo-server
# 或
uv add gg-mcp-demo-server
```

需要 Python 3.13 及以上。发行名是 `gg-mcp-demo-server`，安装后的命令与导入名仍是 `gg-mcp-demo` / `gg_mcp_demo`。

## 运行

```bash
gg-mcp-demo              # 默认 stdio，供客户端拉起
MCP_TRANSPORT=sse gg-mcp-demo
```

环境变量：

| 变量 | 默认值 | 说明 |
| --- | --- | --- |
| `MCP_TRANSPORT` | `stdio` | 传输方式：`stdio` / `sse` / `streamable-http` |
| `GG_MCP_DEMO_LOG_DIR` | 见下 | 调用日志所在目录 |

调用日志默认写入当前用户的状态目录：

- Windows：`%LOCALAPPDATA%\gg-mcp-demo\logs\mcp-calls.log`
- Linux/macOS：`$XDG_STATE_HOME/gg-mcp-demo/logs/mcp-calls.log`（未设置时为 `~/.local/state/...`）

## 在客户端里配置

以 stdio 方式接入 Cherry Studio / Cline / Claude Desktop 等客户端：

```json
{
  "mcpServers": {
    "gg-mcp-demo": {
      "command": "gg-mcp-demo",
      "env": {
        "GG_MCP_DEMO_LOG_DIR": "D:/logs/gg-mcp-demo"
      }
    }
  }
}
```

## 提供的 tool 与 resource

- `add(a: int, b: int) -> int`：返回两数之和。
- `greeting://{name}`：返回 `Hello, {name}!`。

## 日志示例

```
[17:30:14.312] pid=23112 --> tools/call id=2 params={"name": "add", "arguments": {"a": 1, "b": 2}}
[17:30:14.313] pid=23112 <-- tools/call id=2 OK 1.2ms result={"content": [{"type": "text", "text": "3"}]}
```

## 许可

未声明许可证（发布前请按需要补充）。
