Skip to main content
Glama
GongRzhe

Office Word MCP Server

add_endnote_to_document

Insert endnotes into Word documents to cite sources or add references at specific paragraphs, enabling proper academic or professional documentation.

Instructions

Add an endnote to a specific paragraph in a Word document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filenameYes
paragraph_indexYes
endnote_textYes

Implementation Reference

  • Core implementation of the add_endnote_to_document tool. This async function handles document validation, adds a superscript dagger symbol as endnote reference to the specified paragraph, creates an 'Endnotes' section if needed, appends the endnote text, and saves the document.
    async def add_endnote_to_document(filename: str, paragraph_index: int, endnote_text: str) -> str:
        """Add an endnote to a specific paragraph in a Word document.
        
        Args:
            filename: Path to the Word document
            paragraph_index: Index of the paragraph to add endnote to (0-based)
            endnote_text: Text content of the endnote
        """
        filename = ensure_docx_extension(filename)
        
        # Ensure paragraph_index is an integer
        try:
            paragraph_index = int(paragraph_index)
        except (ValueError, TypeError):
            return "Invalid parameter: paragraph_index must be an integer"
        
        if not os.path.exists(filename):
            return f"Document {filename} does not exist"
        
        # Check if file is writeable
        is_writeable, error_message = check_file_writeable(filename)
        if not is_writeable:
            return f"Cannot modify document: {error_message}. Consider creating a copy first."
        
        try:
            doc = Document(filename)
            
            # Validate paragraph index
            if paragraph_index < 0 or paragraph_index >= len(doc.paragraphs):
                return f"Invalid paragraph index. Document has {len(doc.paragraphs)} paragraphs (0-{len(doc.paragraphs)-1})."
            
            paragraph = doc.paragraphs[paragraph_index]
            
            # Add endnote reference
            last_run = paragraph.add_run()
            last_run.text = "†"  # Unicode dagger symbol common for endnotes
            last_run.font.superscript = True
            
            # Check if endnotes section exists, if not create it
            endnotes_heading_found = False
            for para in doc.paragraphs:
                if para.text == "Endnotes:" or para.text == "ENDNOTES":
                    endnotes_heading_found = True
                    break
            
            if not endnotes_heading_found:
                # Add a page break before endnotes section
                doc.add_page_break()
                doc.add_heading("Endnotes:", level=1)
            
            # Add the endnote text
            endnote_para = doc.add_paragraph("† " + endnote_text)
            endnote_para.style = "Endnote Text" if "Endnote Text" in doc.styles else "Normal"
            
            doc.save(filename)
            return f"Endnote added to paragraph {paragraph_index} in {filename}"
        except Exception as e:
            return f"Failed to add endnote: {str(e)}"
  • MCP tool registration for 'add_endnote_to_document' using the @mcp.tool() decorator. This sync wrapper delegates execution to the async implementation in footnote_tools.
    @mcp.tool()
    def add_endnote_to_document(filename: str, paragraph_index: int, endnote_text: str):
        """Add an endnote to a specific paragraph in a Word document."""
        return footnote_tools.add_endnote_to_document(filename, paragraph_index, endnote_text)
  • Re-export of add_endnote_to_document from footnote_tools.py, making it available when importing from the tools package.
    from word_document_server.tools.footnote_tools import (
        add_footnote_to_document, add_endnote_to_document,
        convert_footnotes_to_endnotes_in_document, customize_footnote_style
    )
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions adding an endnote but doesn't cover important aspects like whether this modifies the document in place, requires specific permissions, handles errors (e.g., invalid paragraph index), or what the expected outcome is. This leaves significant gaps for a mutation tool.

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 a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, making it easy to understand at a glance.

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?

For a mutation tool with 3 parameters, 0% schema coverage, no annotations, and no output schema, the description is inadequate. It lacks details on behavior, error handling, prerequisites, and doesn't compensate for the missing structured information, leaving the agent with insufficient context.

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 only implies 'paragraph_index' and 'endnote_text' through context but doesn't explain what 'filename' refers to (e.g., path, document name), how paragraph indexing works, or format expectations for endnote text. This adds minimal value beyond the schema.

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 ('Add an endnote') and target ('to a specific paragraph in a Word document'), which is specific and unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'add_footnote_to_document' or other footnote-related tools, which would require a 5.

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 like footnote tools or other document annotation methods. It states what the tool does but offers no context about appropriate use cases or exclusions.

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/GongRzhe/Office-Word-MCP-Server'

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