Skip to main content
Glama

Resolve Comment

affine_resolve_comment

Mark comments as resolved or unresolved in AFFiNE workspaces to streamline feedback management and improve collaboration during document editing.

Instructions

Resolve or unresolve a comment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
resolvedYes

Implementation Reference

  • The async handler function that executes the tool logic: performs a GraphQL mutation to resolve or unresolve a comment.
    const resolveCommentHandler = async (parsed: { id: string; resolved: boolean }) => {
      const mutation = `mutation ResolveComment($input: CommentResolveInput!){ resolveComment(input:$input) }`;
      const data = await gql.request<{ resolveComment: boolean }>(mutation, { input: parsed });
      return text({ success: data.resolveComment });
    };
  • Registers the 'affine_resolve_comment' tool, including input schema and links to the handler.
    server.registerTool(
      "affine_resolve_comment",
      {
        title: "Resolve Comment",
        description: "Resolve or unresolve a comment.",
        inputSchema: {
          id: z.string(),
          resolved: z.boolean()
        }
      },
      resolveCommentHandler as any
    );
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. It states the action ('Resolve or unresolve') but doesn't clarify permissions required, whether it's reversible, side effects (e.g., notifications), or response format. For a mutation tool with zero annotation coverage, this leaves critical behavioral traits unspecified, though it correctly implies a write operation.

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

Conciseness5/5

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

The description is extremely concise with a single sentence ('Resolve or unresolve a comment.'), front-loaded with the core action. Every word earns its place by directly stating the tool's function without redundancy or fluff, making it efficient for quick comprehension.

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 (a mutation tool with 2 parameters), no annotations, no output schema, and 0% schema coverage, the description is incomplete. It lacks details on behavioral traits, parameter semantics, and expected outcomes, leaving significant gaps for the agent to infer usage. While concise, it doesn't provide enough context for reliable tool invocation.

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. It mentions 'comment' but doesn't explain the 'id' parameter (e.g., comment identifier) or 'resolved' (boolean to set resolution status). The description adds minimal value beyond the schema's structure, failing to clarify parameter meanings or usage, which is inadequate given the low coverage.

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 action ('Resolve or unresolve') and resource ('a comment'), making the purpose immediately understandable. It distinguishes from siblings like 'affine_create_comment' or 'affine_delete_comment' by focusing on resolution status rather than creation or deletion. However, it doesn't specify the exact mechanism or context (e.g., in a document), which prevents a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing an existing comment), exclusions, or comparisons with siblings like 'affine_update_comment' (which might handle other comment modifications). Without such context, the agent lacks direction on appropriate usage scenarios.

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

Related 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/DAWNCR0W/affine-mcp-server'

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