get_writing_guide
Access systematic principles for crafting high-quality technical content with the Open Strategy Partners writing guide. Learn narrative structure, flow, style, and technical accuracy for effective content creation.
Instructions
Get the Open Strategy Partners (OSP) writing guide and usage protocol for creating high-quality technical content. This guide provides systematic principles for narrative structure, flow, style, and technical accuracy.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/index.ts:54-82 (handler)The complete handler implementation for the 'get_writing_guide' MCP tool. It reads the 'guide-llm.md' file using the ContentReader utility and returns the content in a standardized JSON format, with error handling.server.tool( "get_writing_guide", "Get the Open Strategy Partners (OSP) writing guide and usage protocol for creating high-quality technical content. This guide provides systematic principles for narrative structure, flow, style, and technical accuracy.", async (_extra) => { try { const content = await contentReader.readMarkdownFile('guide-llm.md'); return { content: [{ type: "text", text: JSON.stringify({ success: true, data: { content } }) }] }; } catch (error) { return { content: [{ type: "text", text: JSON.stringify({ success: false, error: error instanceof Error ? error.message : String(error) }) }], isError: true }; } } );
- src/tools/index.ts:54-82 (registration)Registration of the 'get_writing_guide' tool using McpServer.tool() within the registerTools function.server.tool( "get_writing_guide", "Get the Open Strategy Partners (OSP) writing guide and usage protocol for creating high-quality technical content. This guide provides systematic principles for narrative structure, flow, style, and technical accuracy.", async (_extra) => { try { const content = await contentReader.readMarkdownFile('guide-llm.md'); return { content: [{ type: "text", text: JSON.stringify({ success: true, data: { content } }) }] }; } catch (error) { return { content: [{ type: "text", text: JSON.stringify({ success: false, error: error instanceof Error ? error.message : String(error) }) }], isError: true }; } } );
- src/utils/contentReader.ts:14-32 (helper)Supporting utility method ContentReader.readMarkdownFile used by the get_writing_guide handler to load and cache the guide markdown content.async readMarkdownFile(filename: string): Promise<string> { // Check cache if (this.cache.has(filename)) { return this.cache.get(filename)!; } try { const filePath = join(this.resourcesDir, filename); const content = await readFile(filePath, 'utf-8'); // Store in cache this.cache.set(filename, content); return content; } catch (error) { console.error(`Error reading file ${filename}:`, error); throw new Error(`Required file '${filename}' not found`); } }