mcpField
K
kb-summarization

kb-summarization

github.com/happy-technologies-llc生产力4141 次安装2 天前更新
代码仓库

关于 kb-summarization

此技能用于汇总 ServiceNow 知识库文章,面向需要快速掌握文章内容、制作摘要或整理知识简报的用户。它提供多种摘要形式、主题提取、可读性评估及多篇文章综合,并可将结果写回记录。

主要功能

  1. 01生成执行摘要与速览要点
  2. 02提取关键行动项和主题
  3. 03简化复杂技术内容
  4. 04综合多篇相关文章
  5. 05评估可读性与内容质量
  6. 06将摘要写回文章记录

适用场景

  1. 01为搜索结果生成文章预览
  2. 02制作面向管理层的知识简报
  3. 03将入职分类文章整理成检查清单

MCP 相关

文档使用 ServiceNow MCP 工具读取文章和使用指标、检索文章,并将摘要或主题标签更新到记录中。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/happy-technologies-llc/happy-platform-skills --skill kb-summarization

安装后在 Claude Code 中输入/kb-summarization确认已加载。

详细介绍

知识文章摘要

概述

此技能可生成 ServiceNow 知识库文章的简明摘要,并提供针对不同阅读场景优化的多种格式:

  • 执行摘要:为领导层和决策者提供高层概述
  • TL;DR 要点:超精简关键要点,便于快速浏览
  • 关键要点:从长篇文章中提取可执行事项和关键信息
  • 主题提取:识别主要和次要主题,以便分类
  • 可读性优化:简化复杂的技术内容,让更广泛的受众也能理解
  • 多篇文章综合:将相关文章整合为统一摘要

适用场景: 用户需要快速了解文章内容而无需阅读全文、构建知识摘要或新闻简报、为搜索结果添加摘要预览,或评估文章质量和覆盖范围时。

前提条件

  • 角色: knowledge_manager、knowledge 或 admin
  • 插件: com.glideapp.knowledge(知识管理)
  • 访问权限: 对 kb_knowledge、kb_knowledge_base、kb_category 具有读取权限
  • 知识: 知识库结构、文章生命周期状态、内容分类体系
  • 相关技能: 用于创建文章的 knowledge/article-generation,以及用于覆盖范围评估的 knowledge/gap-analysis

流程

步骤 1:检索知识文章

获取完整文章内容,包括用于提供上下文的元数据。

MCP 方法:

Tool: SN-Get-Record
Parameters:
  table_name: kb_knowledge
  sys_id: <article_sys_id>
  fields: sys_id,number,short_description,text,kb_knowledge_base,kb_category,author,sys_created_on,sys_updated_on,workflow_state,article_type,rating,sys_view_count,wiki

REST 方法:

GET /api/now/table/kb_knowledge/<article_sys_id>
  ?sysparm_fields=sys_id,number,short_description,text,kb_knowledge_base,kb_category,author,sys_created_on,sys_updated_on,workflow_state,article_type,rating,sys_view_count
  &sysparm_display_value=true

按关键字搜索:

Tool: SN-Query-Table
Parameters:
  query: workflow_state=published^123TEXTQUERY321=VPN connection troubleshooting
  table_name: kb_knowledge
  limit: 5
步骤 2:分析文章结构和内容

解析文章正文(text 或 wiki 字段),以识别:

  • 标题和章节:表示内容层级的 H1-H6 标签
  • 分步流程:表示操作说明的编号列表或项目符号列表
  • 代码块:技术脚本或配置片段
  • 表格:结构化数据、对比矩阵或参考信息
  • 图片/附件:可能包含关键信息的引用媒体
  • 链接:指向其他文章或外部资源的交叉引用
  • 内容长度:字数和预计阅读时间
步骤 3:检索文章使用指标

了解文章的使用情况,以便调整摘要。

MCP 方法:

Tool: SN-Query-Table
Parameters:
  table_name: kb_use
  query: article=<article_sys_id>^ORDERBYDESCsys_created_on
  fields: sys_id,article,user,sys_created_on,useful
  limit: 100
Tool: SN-Query-Table
Parameters:
  table_name: kb_feedback
  query: article=<article_sys_id>^ORDERBYDESCsys_created_on
  fields: sys_id,article,user,rating,comments,sys_created_on
  limit: 20
步骤 4:生成执行摘要

创建适合领导层和非技术利益相关者阅读的高层概述:

=== EXECUTIVE SUMMARY ===
Article: KB0012345 - VPN Connection Troubleshooting Guide
Category: Network Services > Remote Access
Last Updated: 2025-10-15
Views: 2,340 | Rating: 4.2/5

SUMMARY:
This article provides a comprehensive troubleshooting guide for VPN
connectivity issues affecting remote workers. It covers the three most
common failure scenarios (authentication failures, split tunnel
configuration, and DNS resolution), provides step-by-step resolution
procedures for each, and includes escalation paths when self-service
resolution is not possible.

KEY IMPACT:
- Addresses the #2 most common IT support request (VPN issues)
- Self-service resolution rate: estimated 65% of VPN tickets
- Applicable to all remote employees (approx. 3,200 users)

AUDIENCE: End users and Level 1 support agents
READING TIME: 12 minutes (full article)
步骤 5:生成 TL;DR 要点

创建便于快速浏览的超精简摘要:

=== TL;DR ===
Article: KB0012345 - VPN Connection Troubleshooting

- Restart the VPN client and clear cached credentials before anything else
- Authentication failures: Reset password via SSO portal, then reconnect
- Split tunnel issues: Run the diagnostic script (Section 3) to auto-fix routing
- DNS not resolving: Flush DNS cache and set DNS to automatic in VPN settings
- If none of the above work: Contact the Network Operations team (Priority 3)
- Known issue: VPN client v4.2 has a bug on macOS Sonoma -- update to v4.3+
步骤 6:提取关键要点

识别可执行事项和关键信息:

=== KEY TAKEAWAYS ===
Article: KB0012345

MUST KNOW:
1. Always restart the VPN client before attempting other troubleshooting steps
2. VPN client version 4.2 has a known incompatibility with macOS Sonoma
3. Split tunnel is enabled by default -- corporate resources use the tunnel,
   internet traffic goes direct

ACTION ITEMS:
- Update VPN client to v4.3 or later if running macOS Sonoma
- Bookmark the self-service diagnostic tool: https://vpn-diag.internal/
- Save the Network Operations team contact for escalations

COMMON MISTAKES TO AVOID:
- Do not manually configure DNS servers -- the VPN client sets these automatically
- Do not disable split tunneling without IT approval (causes bandwidth issues)
- Do not use personal VPN services simultaneously with corporate VPN

RELATED RESOURCES:
- KB0012001: VPN Client Installation Guide
- KB0012189: Remote Desktop Connection Setup
- KB0012290: Network Drive Mapping for Remote Users
步骤 7:生成主题标签

提取主要和次要主题,以改进分类:

MCP 方法:

Tool: SN-Update-Record
Parameters:
  table_name: kb_knowledge
  sys_id: <article_sys_id>
  data:
    u_topics: "vpn,troubleshooting,remote-access,network,authentication,dns,split-tunnel"
    u_primary_topic: "vpn-troubleshooting"
    u_audience: "end-user,level-1-support"
步骤 8:评估可读性和质量

评估文章的可读性和完整性:

=== QUALITY ASSESSMENT ===
Readability Score: Intermediate (suitable for technical staff)
Content Completeness: 85% (missing mobile device VPN instructions)
Structure Quality: Good (clear headings, numbered steps, screenshots referenced)
Currency: Current (updated 2 months ago, all links valid)
User Feedback: Positive (4.2/5 from 156 ratings)

IMPROVEMENT SUGGESTIONS:
1. Add mobile device (iOS/Android) VPN setup section
2. Include a flowchart for the decision tree (text-only currently)
3. Add estimated resolution time for each scenario
4. Update screenshot for VPN client v4.3 interface changes
步骤 9:生成多篇文章综合摘要(可选)

将多篇相关文章整理为统一摘要时:

MCP 方法:

Tool: SN-Query-Table
Parameters:
  table_name: kb_knowledge
  query: kb_category=<category_sys_id>^workflow_state=published^ORDERBYDESCsys_view_count
  fields: sys_id,number,short_description,text,sys_view_count,rating,sys_updated_on
  limit: 10

整理为主题摘要:

=== KNOWLEDGE DIGEST: Remote Access ===
Articles Summarized: 5
Total Coverage: VPN setup, troubleshooting, remote desktop, file access, security

1. KB0012345 - VPN Troubleshooting (2,340 views)
   Quick fix for VPN issues: restart client, update to v4.3, flush DNS

2. KB0012001 - VPN Installation (1,890 views)
   Step-by-step VPN client setup for Windows, Mac, and Linux

3. KB0012189 - Remote Desktop Setup (1,456 views)
   Configure RDP/SSH access to office workstations from home

4. KB0012290 - Network Drives (1,203 views)
   Map corporate file shares over VPN with drive letter assignments

5. KB0012310 - Remote Security Policy (980 views)
   Security requirements for remote work: MFA, disk encryption, screen lock
步骤 10:保存或分发摘要

将生成的摘要保存为文章字段,或创建关联记录。

MCP 方法:

Tool: SN-Update-Record
Parameters:
  table_name: kb_knowledge
  sys_id: <article_sys_id>
  data:
    u_executive_summary: "<executive summary text>"
    u_tldr: "<tldr bullets>"
    u_key_takeaways: "<takeaways text>"

工具使用

工具用途使用场景
SN-Get-Record通过 sys_id 获取完整文章内容单篇文章摘要
SN-Query-Table按类别、关键字或指标获取文章多篇文章摘要和发现
SN-Update-Record将摘要保存回文章记录持久化生成的摘要
SN-Natural-Language-Search通过自然语言查询查找文章未知文章编号时

最佳实践

  1. 保持技术准确性 —— 摘要不得引入错误或过度简化
  2. 根据受众调整摘要格式 —— 管理层需要了解影响,技术人员需要操作步骤
  3. 包含文章元数据 —— 始终显示文章编号、上次更新日期和评分
  4. 标记过时内容 —— 如果文章超过 6 个月未更新,请注明
  5. 保留交叉引用 —— 每种摘要格式都应包含相关文章的链接
  6. 尊重内容敏感性 —— 分发摘要前,检查文章的可见性设置
  7. 提供预计阅读时间 —— 帮助用户决定是否阅读完整文章
  8. 提取警告和注意事项 —— 摘要中必须包含关键安全或合规说明
  9. 使用一致的格式 —— 在整个知识库中统一摘要模板
  10. 跟踪摘要使用情况 —— 监控摘要是否减少了完整文章的阅读量,或提高了解决率

故障排除

问题原因解决方法
文章正文为空内容存储在 wiki 字段中,而不是 text 字段中同时检查 text 和 wiki 字段
摘要中出现 HTML 标签未从文章正文中剥除原始 HTML先解析 HTML 并提取纯文本,再进行摘要
找不到文章表错误,或文章处于草稿状态使用 workflow_state=published 查询,或检查 kb_knowledge_base 范围
缺少使用指标未启用知识使用跟踪在 Knowledge Management 属性中启用 kb_use 跟踪
反馈记录为空此知识库未启用反馈功能在知识库配置中检查反馈设置
摘要过长文章内容非常全面按摘要格式限制字数(TL;DR:100 个词,Executive:200 个词)

示例

示例 1:搜索结果的快速摘要

输入: “用 2 句话总结 KB0012345,作为搜索预览”

输出: “本文介绍了三种最常见的 VPN 连接故障(身份验证、拆分隧道、DNS),并提供分步解决流程。大多数问题都可以通过重启 VPN 客户端并更新到 4.3 或更高版本来解决。”

示例 2:面向 IT 管理层的执行摘要

输入: “为浏览量最高的 10 篇文章生成每周知识摘要”

步骤: 查询过去一周按 sys_view_count 排序的 kb_knowledge,为每篇文章生成执行摘要,并汇编成格式化摘要,包含趋势分析(新文章、热度上升的文章、热度下降的文章)。

示例 3:入职知识包

输入: “总结‘New Employee Setup’类别下的所有文章,制作入职检查清单”

步骤: 查询该类别下所有已发布的文章,从每篇文章中提取关键操作事项,并汇编成按顺序排列的检查清单,同时附上完整文章的链接以供查看详情。

相关技能

  • knowledge/article-generation - 创建新的知识文章
  • knowledge/gap-analysis - 识别缺失的知识覆盖
  • knowledge/content-recommendation - 向用户推荐相关文章
  • knowledge/duplicate-detection - 查找重复或重叠的文章
  • knowledge/gap-grouping - 按主题对知识缺口进行分组

评论

支持 Markdown