Skip to main content
Glama

open_document

Open and access Word documents for reading or editing by providing the file path to enable document interaction through natural language commands.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYes

Implementation Reference

  • Core handler function that opens a Word document by reading the file and extracting its raw text content using the mammoth library.
    async openDocument(filePath: string): Promise<APIResponse> {
      try {
        const buffer = await fs.readFile(filePath);
        const result = await mammoth.extractRawText({ buffer });
        return { success: true, data: { content: result.value } };
      } catch (error) {
        const err = error as Error;
        return { success: false, error: `打开文档失败: ${err.message}` };
      }
    }
  • Registers the 'open_document' tool with the MCP server, defining the input schema using Zod and implementing the execution logic by calling DocumentService.openDocument.
    server.tool(
      "open_document",
      {
        filePath: z.string(),
      },
      async (params) => {
        const result = await docService.openDocument(params.filePath);
        return {
          content: [
            {
              type: "text",
              text: result.success ? result.data!.content : result.error!,
            },
          ],
          isError: !result.success,
        };
      }
    );
  • JSON Schema definition for the 'open_document' tool input parameters in the HTTP server's tools list.
    name: 'open_document',
    description: '打开 Word 文档',
    parameters: {
      properties: {
        filePath: { type: 'string', description: '文档路径' },
      },
      required: ['filePath'],
      type: 'object',
    },
  • Handler dispatch in the HTTP server that calls DocumentService.openDocument for the 'open_document' tool.
    case 'open_document':
      result = await docService.openDocument(parameters.filePath);
      break;
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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/puchunjie/doc-tools-mcp'

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