Skip to main content
Glama
xiaobenyang-com

Search-Apple-Docs

get_documentation_updates

get_documentation_updates

Track Apple platform updates, API changes, and release notes to stay informed about development changes. Shows WWDC announcements and framework updates for current Apple development.

Instructions

Track latest Apple platform updates, new APIs, and changes. Shows WWDC announcements, framework updates, and release notes. Essential for staying current with Apple development. For detailed WWDC videos, use WWDC-specific tools.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
categoryNo
technologyNo
yearNo
searchQueryNo
includeBetaNo
limitNo

Implementation Reference

  • Core execution logic for all tools, including get_documentation_updates. Fetches from remote API https://mcp.xiaobenyang.com/api using the toolName as 'func' header and args as body.
    const calcXiaoBenYangApi = async function (fullArgs: Record<string, any>) {
        // 发起 POST 请求
        let response = await fetch('https://mcp.xiaobenyang.com/api', {
            method: 'POST',
            headers: {
                'XBY-APIKEY': apiKey,
                'func': fullArgs.toolName,
                'mcpid': mcpID
            },
            body: new URLSearchParams(fullArgs)
        });
        const apiResult = await response.text();
    
        return {
            content: [
                {
                    type: "text",
                    text: apiResult // 将字符串结果放入 content 中
                }
            ]
        } as { [x: string]: unknown; content: [{ type: "text"; text: string }] };
    };
  • Handler registered for each tool. Validates toolName and calls the core API function with merged args.
    const handleXiaoBenYangApi = async (args: Record<string, any>, toolName: string) => {
        // 校验aid是否存在
        if (toolName === undefined || toolName === null) {
            throw new Error("缺少必要参数 'aid'");
        }
        // 合并参数
        const fullArgs = {...args, toolName: toolName};
        // 调用API
        return calcXiaoBenYangApi(fullArgs);
    };
  • src/mcp.ts:50-65 (registration)
    Helper function that registers a tool with name, description, inputSchema, and the generic handler. Called dynamically for each remote tool.
    const addToolXiaoBenYangApi = function (
        name: string,
        desc: string,
        params: Record<string, ZodType>
    ) {
        server.registerTool(
            name,
            {
                title: name,
                description: desc,
                inputSchema: params,
            }
            ,
            async (args: Record<string, any>) => handleXiaoBenYangApi(args, name)
        )
    };
  • src/mcp.ts:90-132 (registration)
    Dynamically fetches tool list from https://mcp.xiaobenyang.com/getMcpDesc?mcpId=1777316659692547, builds Zod inputSchema for each, and registers using addToolXiaoBenYangApi. This registers 'get_documentation_updates' if present remotely.
    for (const apiDesc of apiDescList) {
        let inputSchema = JSON.parse(apiDesc.inputSchema);
        const zodDict: Record<string, z.ZodTypeAny> = {};
    
        Object.entries(inputSchema.properties).forEach(([name, propConfig]) => {
            let zodType;
            let pt = (propConfig as { type: string }).type;
            switch (pt) {
                case 'string':
                    zodType = z.string();
                    break;
                case 'number':
                    zodType = z.number();
                    break;
                case 'boolean':
                    zodType = z.boolean();
                    break;
                case 'integer':
                    zodType = z.bigint();
                    break;
                case 'array':
                    zodType = z.array(z.any());
                    break;
                case 'object':
                    zodType = z.object(z.any());
                    break;
                default:
                    zodType = z.any();
            }
    
            if (inputSchema.required?.includes(name)) {
                zodDict[name] = zodType;
            } else {
                zodDict[name] = zodType.optional();
            }
        });
    
    
        addToolXiaoBenYangApi(
            apiDesc.name,
            apiDesc.description ? apiDesc.description : apiDesc.name,
            zodDict);
    }
  • Builds Zod schema dictionary from remote tool's inputSchema JSON, mapping types to Zod types and handling required/optional.
    let inputSchema = JSON.parse(apiDesc.inputSchema);
    const zodDict: Record<string, z.ZodTypeAny> = {};
    
    Object.entries(inputSchema.properties).forEach(([name, propConfig]) => {
        let zodType;
        let pt = (propConfig as { type: string }).type;
        switch (pt) {
            case 'string':
                zodType = z.string();
                break;
            case 'number':
                zodType = z.number();
                break;
            case 'boolean':
                zodType = z.boolean();
                break;
            case 'integer':
                zodType = z.bigint();
                break;
            case 'array':
                zodType = z.array(z.any());
                break;
            case 'object':
                zodType = z.object(z.any());
                break;
            default:
                zodType = z.any();
        }
    
        if (inputSchema.required?.includes(name)) {
            zodDict[name] = zodType;
        } else {
            zodDict[name] = zodType.optional();
        }
    });
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. While it mentions what the tool tracks (updates, APIs, changes), it doesn't describe key behavioral traits such as whether this is a read-only operation, what format the output takes, whether it requires authentication, or if there are rate limits. For a tool with 6 parameters and no annotation coverage, this is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized with three sentences. The first sentence states the core purpose, the second adds context, and the third provides usage guidance. It's front-loaded with the main function and avoids unnecessary elaboration, though the second sentence ('Essential for staying current...') is somewhat redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (6 parameters, no annotations, no output schema), the description is incomplete. It covers purpose and some usage guidelines but lacks behavioral transparency, parameter explanations, and output details. For a tool with this level of complexity and no structured support, the description should provide more comprehensive guidance to be effective.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for undocumented parameters. The description mentions categories like 'Apple platform updates, new APIs, and changes' and 'WWDC announcements, framework updates, and release notes,' which loosely relate to parameters like category and technology. However, it doesn't explain any of the 6 parameters (e.g., what category values are valid, what technology refers to, how searchQuery works), leaving most semantics unclear.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Track latest Apple platform updates, new APIs, and changes' with specific resources (WWDC announcements, framework updates, release notes). It distinguishes from some siblings by mentioning WWDC-specific tools, though not all alternatives are addressed. The verb 'track' is somewhat vague compared to more precise verbs like 'list' or 'retrieve'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use alternatives: 'For detailed WWDC videos, use WWDC-specific tools.' This distinguishes it from siblings like get_wwdc_video. However, it doesn't clarify when to use this tool versus other documentation-related siblings like search_apple_docs or get_apple_doc_content, leaving some ambiguity.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/xiaobenyang-com/Search-Apple-Docs'

If you have feedback or need assistance with the MCP directory API, please join our Discord server