Handbook

io.github.jannks由 GitHub 账号 jannks 发布v1.0.1更新于 Nov 3, 2026

MCP server for the Handbook API – manage handbook entries via CRUD, overview and tag search.

已验证STDIO仅桌面效率与工作流知识与记忆

概览

AI 生成的概览

面向 ah-oh Handbook API 的 MCP 服务器,让助手列出、读取、创建、更新、删除手册条目并按标签搜索。

可以做什么
  • 列出并读取手册条目,可按 ID 获取单条条目的 Markdown 内容
  • 创建和更新条目,并按 ID 删除条目
  • 获取按应用分组的全部条目精简概览
  • 在所有条目中搜索标签
适用场景
当你的文档或笔记存放在 ah-oh Handbook 中,并希望助手在 Claude Desktop、Claude Code 或 VS Code 等客户端里查询条目、起草新条目或维护已有条目时使用。
运行要求
以本地 Node.js(18 及以上)进程运行,可从 npm 包安装或从源码构建。需要在 HANDBOOK_API_TOKEN 中提供 Handbook API 的 Bearer 令牌;可用 HANDBOOK_API_URL 覆盖默认 API 地址。需要能访问 Handbook API 的网络。
安装前请注意
HANDBOOK_API_TOKEN 中的令牌可访问你的 Handbook 数据,并会保存在客户端配置文件中。该服务器可创建、更新和删除条目,助手的操作可能改动或删除文档,执行写入和删除前请先确认。条目内容会发送到所配置的 Handbook API 地址。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Handbook,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

handbook-mcp-server

An MCP (Model Context Protocol) server for the Handbook API by ah-oh.com. Enables full management of handbook entries directly from Claude Desktop, Claude Code, VS Code Copilot, and other MCP-compatible clients.


Features

ToolDescription
handbook_list_entriesList all handbook entries
handbook_get_entryRetrieve a single entry by ID (including markdown content)
handbook_create_entryCreate a new entry
handbook_update_entryUpdate an existing entry
handbook_delete_entryDelete an entry
handbook_get_overviewCompact overview of all entries per app
handbook_search_tagsSearch tags across all entries

Prerequisites

  • Node.js >= 18
  • Bearer Token for the Handbook API

Installation

Option A: Install from npm

bash
npm install -g @ah-oh/handbook-mcp-server

Option B: Build from source

bash
git clone https://github.com/ah-oh/handbook-mcp-server.gitcd handbook-mcp-servernpm installnpm run build

Configuration

Environment Variables

VariableRequiredDefaultDescription
HANDBOOK_API_TOKENYes–Bearer token for the Handbook API
HANDBOOK_API_URLNohttps://handbook.ah-oh.com/handbook-apiBase URL of the API
TRANSPORTNostdioTransport mode: stdio or http
PORTNo3000Port for HTTP transport

Usage

Claude Desktop

Add the following to your claude_desktop_config.json:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

json
{  "mcpServers": {    "handbook": {      "command": "node",      "args": ["/absolute/path/to/handbook-mcp-server/dist/index.js"],      "env": {        "HANDBOOK_API_TOKEN": "your-bearer-token"      }    }  }}

If installed globally via npm:

json
{  "mcpServers": {    "handbook": {      "command": "handbook-mcp-server",      "env": {        "HANDBOOK_API_TOKEN": "your-bearer-token"      }    }  }}

Claude Code

bash
claude mcp add handbook -- node /path/to/handbook-mcp-server/dist/index.js \  --env HANDBOOK_API_TOKEN=your-bearer-token

VS Code (Copilot / Continue)

In .vscode/mcp.json:

json
{  "servers": {    "handbook": {      "command": "node",      "args": ["/path/to/handbook-mcp-server/dist/index.js"],      "env": {        "HANDBOOK_API_TOKEN": "your-bearer-token"      }    }  }}

HTTP Mode (Remote)

bash
TRANSPORT=http HANDBOOK_API_TOKEN=your-token PORT=3000 npm start

The server will listen on http://localhost:3000/mcp.


Examples

Once the MCP server is connected, you can ask Claude things like:

  • "Show me all handbook entries"
  • "Create a new entry titled 'Onboarding Guide' for the app szales"
  • "Update the entry with ID 65c4e1f5... – set the content to ..."
  • "Which tags start with 'meet'?"
  • "Give me an overview of all entries for the app sethub"
  • "Delete entry 65c4e1f5..."

Publishing to the MCP Registry

The official MCP Registry makes your server discoverable by all MCP clients. Here's the step-by-step guide:

Step 1: Replace placeholders

Replace ah-oh everywhere in the project with your GitHub username:

bash
# macOSfind . -type f \( -name "*.json" -o -name "*.md" \) \  -exec sed -i '' 's/ah-oh/my-github-user/g' {} +
# Linuxfind . -type f \( -name "*.json" -o -name "*.md" \) \  -exec sed -i 's/ah-oh/my-github-user/g' {} +

This affects the following files:

  • package.json – fields name, mcpName, repository, homepage, bugs
  • server.json – fields name, repository, packages[0].identifier
  • README.md – links and install command

Step 2: Publish to npm

bash
# Log in to npm (one-time)npm login
# Publish the packagenpm publish --access public

Note: The MCP Registry only hosts metadata, not the code itself. Your package must first be available on npm (or PyPI, Docker Hub, etc.).

Step 3: Install the mcp-publisher CLI

bash
curl -L \  "https://github.com/modelcontextprotocol/registry/releases/latest/download/mcp-publisher_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" \  | tar xz mcp-publisher && sudo mv mcp-publisher /usr/local/bin/
# Verifymcp-publisher --help

Step 4: Log in to the registry

bash
mcp-publisher login github

This opens the browser for GitHub OAuth. You'll get access to the namespace io.github.ah-oh/*.

Alternative (custom domain, e.g. com.ah-oh/*):

bash
# Generate an Ed25519 keypairopenssl genpkey -algorithm Ed25519 -out key.pem
# Host the public key at https://ah-oh.com/.well-known/mcp-registry-auth# Then:mcp-publisher login http --domain=ah-oh.com --private-key=HEX_KEY

Step 5: Publish

bash
# Dry run firstmcp-publisher publish --dry-run
# Publish for realmcp-publisher publish

Your server will then be discoverable at registry.modelcontextprotocol.io and automatically picked up by downstream registries (GitHub, VS Code, etc.).

Step 6 (Optional): Automation via GitHub Actions

The project includes a ready-made workflow file at .github/workflows/publish.yml. It automatically publishes to npm and the MCP Registry on every git tag (v*).

Setup:

  1. Go to npmjs.com → Access Tokens → Create a new token
  2. In GitHub → Repository → Settings → Secrets and Variables → Actions → Add NPM_TOKEN as a secret
  3. Tag a release and push:
bash
git tag v1.0.0git push origin v1.0.0

The pipeline takes care of the rest.

Updating the version

For new versions:

  1. Bump the version in package.json and server.json
  2. Create and push a new tag:
bash
npm version patch   # or minor / majorgit push origin v$(node -p "require('./package.json').version")

Project Structure

handbook-mcp-server/├── .github/workflows/│   └── publish.yml          # CI/CD: npm + MCP Registry├── src/│   ├── index.ts             # Entry point (stdio + HTTP)│   ├── constants.ts         # API URL, limits│   ├── types.ts             # TypeScript interfaces│   ├── schemas/│   │   └── handbook-entry.ts # Zod validation schemas│   ├── services/│   │   ├── api-client.ts    # HTTP client for the Handbook API│   │   └── formatting.ts    # Markdown formatting│   └── tools/│       └── handbook-entry.ts # Tool registrations├── dist/                    # Compiled JS files├── package.json├── tsconfig.json├── server.json              # MCP Registry metadata└── README.md

Development

bash
# Install dependenciesnpm install
# Build TypeScript (one-time)npm run build
# TypeScript watch modenpm run dev
# Start server (stdio)npm start
# Start server (HTTP)TRANSPORT=http npm start

API Reference

Based on the Handbook OpenAPI specification.

All endpoints require Bearer token authentication. The MCP server handles auth headers automatically – you only need to set HANDBOOK_API_TOKEN.


License

MIT

来源:README.md,提交 f5bd345

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.1最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分