关键词

Apple文档开发者工具AI助手代码示例下载文档总结

使用说明

项目简介

Apple文档助手MCP服务器旨在通过Model Context Protocol (MCP) 协议，为大型语言模型（LLM）客户端提供便捷的Apple开发者文档访问能力。它能够执行复杂的文档操作，如智能搜索、深入内容抓取、代码示例下载和AI驱动的文档摘要，极大简化开发者与Apple文档的交互。

主要功能点

  • 搜索Apple开发者文档: 快速查找Apple开发者文档中的API、框架、指南、代码示例和视频等资源。
  • 获取完整文档内容: 通过递归抓取和解析JSON API数据，获取任何Apple开发者文档页面的详细内容。
  • 下载代码示例: 自动下载、解压并分析Apple提供的代码示例项目，并将其保存到您用户主目录下的'~/AppleSampleCode/'目录。支持从文档URL或直接的ZIP文件URL下载。
  • AI驱动总结: 结合搜索、内容抓取和智能摘要，提供针对您具体问题的关键洞察和综合性答案，支持不同详细程度的总结。

安装步骤

  1. 确保您的系统已安装Node.js (版本16或更高)。
  2. 通过npm全局安装该MCP服务器。在命令行中运行以下命令： 
    npm install -g apple-developer-docs-mcp
    如果您希望在特定项目中使用，也可以通过 'npm install apple-developer-docs-mcp' 进行局部安装。

服务器配置

为了让您的MCP客户端（例如VS Code的MCP扩展）能连接到此服务器，您需要在客户端的配置中添加以下JSON信息。此配置将指导客户端如何启动并连接到Apple文档助手MCP服务器。

{
  "servers": {
    "apple-developer-docs": {
      "command": "npx",
      "args": [
        "apple-developer-docs-mcp"
      ],
      "description": "Apple开发者文档MCP服务器，提供搜索、内容获取、代码下载和AI总结功能。"
    }
  }
}
  • 'apple-developer-docs': 这是MCP客户端用于识别此服务器的唯一名称。
  • 'command': 启动MCP服务器的命令行指令，'npx' 用于运行npm包中的可执行文件。
  • 'args': 传递给启动命令的参数，这里是已安装的MCP服务器包的名称 'apple-developer-docs-mcp'。
  • 'description': 对此服务器功能的简要说明，帮助用户理解其用途。

基本使用方法

配置完成后，您的MCP客户端将能发现并连接到“Apple开发者文档”服务器。您可以通过LLM客户端调用服务器提供的以下工具：

  • 'search_apple_docs(query: string, type?: 'all' | 'api' | 'guide' | 'sample' | 'video')': 用于搜索Apple文档。
  • 'get_apple_doc_content(url: string)': 用于获取指定Apple开发者文档URL的详细内容。
  • 'download_apple_code_sample(zipUrl: string)': 用于下载并分析Apple代码示例。
  • 'research_apple_docs(docs_query: string, user_question: string, max_docs?: number, depth?: 's' | 'm' | 'l' | 'xl')': 用于综合研究并总结Apple文档以回答特定的用户问题。

LLM客户端将通过这些工具与服务器交互，从而获取和处理Apple开发者文档信息，并根据您的请求提供智能的响应。

信息

分类

开发者工具

访问项目