Skip to main content
Glama

github_activity_mark_notifications_as_read

Mark GitHub notifications as read to clear unread items. Accepts a request body to specify which notifications to mark.

Instructions

Mark notifications as read

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoRequest body (JSON object)

Implementation Reference

  • The handler function that executes the tool logic. It makes a PUT request to `/notifications` with the request body to mark GitHub notifications as read.
    handler: async (args: Record<string, any>) => {
      return githubRequest("PUT", `/notifications`, args.body, undefined);
    },
  • Input schema for the tool. Accepts an optional 'body' field (a JSON object) as the request body.
    inputSchema: z.object({
      body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
    }),
  • The tool registration entry in the activityTools array. Includes name, description, inputSchema, and handler.
    {
      name: "github_activity_mark_notifications_as_read",
      description: "Mark notifications as read",
      inputSchema: z.object({
        body: z.record(z.string(), z.unknown()).optional().describe("Request body (JSON object)")
      }),
      handler: async (args: Record<string, any>) => {
        return githubRequest("PUT", `/notifications`, args.body, undefined);
      },
    },
  • The githubRequest helper function that performs the actual HTTP request to the GitHub API, handling auth, headers, and error responses.
    export async function githubRequest<T>(
      method: string,
      path: string,
      body?: Record<string, unknown>,
      params?: Record<string, string | number | boolean | string[] | undefined>
    ): Promise<T> {
      const url = new URL(`${BASE_URL}${path}`);
    
      if (params) {
        for (const [key, value] of Object.entries(params)) {
          if (value === undefined || value === null || value === "") continue;
          if (Array.isArray(value)) {
            url.searchParams.set(key, value.join(","));
          } else {
            url.searchParams.set(key, String(value));
          }
        }
      }
    
      const headers: Record<string, string> = {
        Authorization: `Bearer ${getToken()}`,
        Accept: "application/vnd.github+json",
        "X-GitHub-Api-Version": "2022-11-28",
        "User-Agent": "github-mcp/1.0.0",
      };
    
      if (body) {
        headers["Content-Type"] = "application/json";
      }
    
      const res = await fetch(url.toString(), {
        method,
        headers,
        body: body ? JSON.stringify(body) : undefined,
      });
    
      if (!res.ok) {
        const text = await res.text().catch(() => "");
        let detail = text;
        try {
          const json = JSON.parse(text);
          detail = json.message || text;
          if (json.errors) detail += ` -- ${JSON.stringify(json.errors)}`;
        } catch {}
        throw new Error(`GitHub API error ${res.status}: ${detail}`);
      }
    
      if (res.status === 204) return {} as T;
    
      return res.json() as Promise<T>;
    }
  • src/index.ts:110-130 (registration)
    The main MCP server registration loop where each tool (including github_activity_mark_notifications_as_read) is registered with the McpServer via server.tool().
    for (const tool of allTools) {
      server.tool(
        tool.name,
        tool.description,
        tool.inputSchema.shape as any,
        async (args: any) => {
          try {
            const result = await tool.handler(args as any);
            return {
              content: [{ type: "text" as const, text: JSON.stringify(result, null, 2) }],
            };
          } catch (err) {
            const message = err instanceof Error ? err.message : String(err);
            return {
              content: [{ type: "text" as const, text: `Error: ${message}` }],
              isError: true,
            };
          }
        }
      );
    }
Behavior2/5

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

The description implies a state change but does not disclose side effects, permissions required, or the exact behavior (e.g., marks all unread notifications as read?). No annotations are provided to supplement this 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 very concise at one sentence. While it could benefit from more context, it avoids verbosity and gets the main point across efficiently.

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 of sibling tools and lack of output schema, the description is incomplete. It does not explain the scope of notifications affected, the expected body format, or what the tool returns.

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?

The only parameter 'body' is described as 'Request body (JSON object)' with no additional details on expected structure. Despite 100% schema coverage, the schema is unconstrained, and the description fails to clarify what fields are needed or optional.

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 'Mark notifications as read' clearly states the verb and resource. However, it does not differentiate from sibling tools like 'github_activity_mark_repo_notifications_as_read' or 'github_activity_mark_thread_as_read', which share a similar purpose but with different scopes.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. There is no mention of scope (e.g., all notifications vs. per-repo or per-thread), nor any conditions for appropriate usage.

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/Eyalm321/github-mcp'

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