Frontmatter
| id | 7659 |
| title | Docs: Create Self-Explanatory Tools via OpenAPI Descriptions |
| state | Closed |
| labels | documentationenhancementdeveloper-experienceai |
| assignees | tobiu |
| createdAt | Oct 26, 2025, 10:54 AM |
| updatedAt | Oct 26, 2025, 1:03 PM |
| githubUrl | https://github.com/neomjs/neo/issues/7659 |
| author | tobiu |
| commentsCount | 0 |
| parentIssue | 7604 |
| subIssues | [] |
| subIssuesCompleted | 0 |
| subIssuesTotal | 0 |
| contentTrust | |
| projected | |
| quarantined | 0 |
| signals | [] |
| blockedBy | [] |
| blocking | [] |
| closedAt | Oct 26, 2025, 1:03 PM |
Docs: Create Self-Explanatory Tools via OpenAPI Descriptions
tobiu cross-referenced by #7663 on Oct 26, 2025, 1:11 PM
This ticket is a sub-task of the epic #7604.
To reduce the complexity of
AGENTS.md, we will move detailed tool documentation directly into the tool descriptions themselves within the OpenAPI specifications. This will make the tools "self-explanatory".Vision:
The
openapi.yamlfile for each MCP server should become the single source of truth for how to use its tools. An agent should be able to learn how to use a tool just by reading its description.Requirements for each tool's description:
AGENTS.mdwill then be refactored into a higher-level document that directs agents to explore the tools and their embedded documentation.Acceptance Criteria:
openapi.yamlfor all three MCP servers (knowledge-base,memory-core,github-workflow).descriptionfor every tool is comprehensive enough to not require external documentation.